374 lines
11 KiB
PHP
374 lines
11 KiB
PHP
<?php
|
|
|
|
/**
|
|
* CreateDoiContact
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* @category Class
|
|
* @package SendinBlue\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
/**
|
|
* SendinBlue API
|
|
*
|
|
* SendinBlue 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/sendinblue **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@sendinblue.com
|
|
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
* Swagger Codegen version: 2.4.12
|
|
*/
|
|
/**
|
|
* 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 WPMailSMTP\Vendor\SendinBlue\Client\Model;
|
|
|
|
use ArrayAccess;
|
|
use WPMailSMTP\Vendor\SendinBlue\Client\ObjectSerializer;
|
|
/**
|
|
* CreateDoiContact Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package SendinBlue\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class CreateDoiContact implements \WPMailSMTP\Vendor\SendinBlue\Client\Model\ModelInterface, \ArrayAccess
|
|
{
|
|
const DISCRIMINATOR = null;
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $swaggerModelName = 'createDoiContact';
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerTypes = ['email' => 'string', 'attributes' => 'object', 'includeListIds' => 'int[]', 'excludeListIds' => 'int[]', 'templateId' => 'int', 'redirectionUrl' => 'string'];
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerFormats = ['email' => 'email', 'attributes' => null, 'includeListIds' => 'int64', 'excludeListIds' => 'int64', 'templateId' => 'int64', 'redirectionUrl' => 'url'];
|
|
/**
|
|
* 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 = ['email' => 'email', 'attributes' => 'attributes', 'includeListIds' => 'includeListIds', 'excludeListIds' => 'excludeListIds', 'templateId' => 'templateId', 'redirectionUrl' => 'redirectionUrl'];
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = ['email' => 'setEmail', 'attributes' => 'setAttributes', 'includeListIds' => 'setIncludeListIds', 'excludeListIds' => 'setExcludeListIds', 'templateId' => 'setTemplateId', 'redirectionUrl' => 'setRedirectionUrl'];
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = ['email' => 'getEmail', 'attributes' => 'getAttributes', 'includeListIds' => 'getIncludeListIds', 'excludeListIds' => 'getExcludeListIds', 'templateId' => 'getTemplateId', 'redirectionUrl' => 'getRedirectionUrl'];
|
|
/**
|
|
* 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['email'] = isset($data['email']) ? $data['email'] : null;
|
|
$this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null;
|
|
$this->container['includeListIds'] = isset($data['includeListIds']) ? $data['includeListIds'] : null;
|
|
$this->container['excludeListIds'] = isset($data['excludeListIds']) ? $data['excludeListIds'] : null;
|
|
$this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null;
|
|
$this->container['redirectionUrl'] = isset($data['redirectionUrl']) ? $data['redirectionUrl'] : null;
|
|
}
|
|
/**
|
|
* Show all the invalid properties with reasons.
|
|
*
|
|
* @return array invalid properties with reasons
|
|
*/
|
|
public function listInvalidProperties()
|
|
{
|
|
$invalidProperties = [];
|
|
if ($this->container['email'] === null) {
|
|
$invalidProperties[] = "'email' can't be null";
|
|
}
|
|
if ($this->container['includeListIds'] === null) {
|
|
$invalidProperties[] = "'includeListIds' can't be null";
|
|
}
|
|
if ($this->container['templateId'] === null) {
|
|
$invalidProperties[] = "'templateId' 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 email
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getEmail()
|
|
{
|
|
return $this->container['email'];
|
|
}
|
|
/**
|
|
* Sets email
|
|
*
|
|
* @param string $email Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setEmail($email)
|
|
{
|
|
$this->container['email'] = $email;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Gets attributes
|
|
*
|
|
* @return object
|
|
*/
|
|
public function getAttributes()
|
|
{
|
|
return $this->container['attributes'];
|
|
}
|
|
/**
|
|
* Sets attributes
|
|
*
|
|
* @param object $attributes Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setAttributes($attributes)
|
|
{
|
|
$this->container['attributes'] = $attributes;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Gets includeListIds
|
|
*
|
|
* @return int[]
|
|
*/
|
|
public function getIncludeListIds()
|
|
{
|
|
return $this->container['includeListIds'];
|
|
}
|
|
/**
|
|
* Sets includeListIds
|
|
*
|
|
* @param int[] $includeListIds Lists under user account where contact should be added
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setIncludeListIds($includeListIds)
|
|
{
|
|
$this->container['includeListIds'] = $includeListIds;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Gets excludeListIds
|
|
*
|
|
* @return int[]
|
|
*/
|
|
public function getExcludeListIds()
|
|
{
|
|
return $this->container['excludeListIds'];
|
|
}
|
|
/**
|
|
* Sets excludeListIds
|
|
*
|
|
* @param int[] $excludeListIds Lists under user account where contact should not be added
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setExcludeListIds($excludeListIds)
|
|
{
|
|
$this->container['excludeListIds'] = $excludeListIds;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Gets templateId
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getTemplateId()
|
|
{
|
|
return $this->container['templateId'];
|
|
}
|
|
/**
|
|
* Sets templateId
|
|
*
|
|
* @param int $templateId Id of the Double opt-in (DOI) template
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setTemplateId($templateId)
|
|
{
|
|
$this->container['templateId'] = $templateId;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Gets redirectionUrl
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getRedirectionUrl()
|
|
{
|
|
return $this->container['redirectionUrl'];
|
|
}
|
|
/**
|
|
* Sets redirectionUrl
|
|
*
|
|
* @param string $redirectionUrl URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setRedirectionUrl($redirectionUrl)
|
|
{
|
|
$this->container['redirectionUrl'] = $redirectionUrl;
|
|
return $this;
|
|
}
|
|
/**
|
|
* Returns true if offset exists. False otherwise.
|
|
*
|
|
* @param integer $offset Offset
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function offsetExists($offset)
|
|
{
|
|
return isset($this->container[$offset]);
|
|
}
|
|
/**
|
|
* Gets offset.
|
|
*
|
|
* @param integer $offset Offset
|
|
*
|
|
* @return mixed
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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(\WPMailSMTP\Vendor\SendinBlue\Client\ObjectSerializer::sanitizeForSerialization($this), \JSON_PRETTY_PRINT);
|
|
}
|
|
return \json_encode(\WPMailSMTP\Vendor\SendinBlue\Client\ObjectSerializer::sanitizeForSerialization($this));
|
|
}
|
|
}
|