442 lines
11 KiB
PHP
442 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* SsoTokenRequest
|
|
*
|
|
* 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;
|
|
|
|
/**
|
|
* SsoTokenRequest Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package Brevo\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class SsoTokenRequest implements ModelInterface, ArrayAccess
|
|
{
|
|
const DISCRIMINATOR = null;
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $swaggerModelName = 'ssoTokenRequest';
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerTypes = [
|
|
'id' => 'int',
|
|
'email' => 'string',
|
|
'target' => 'string',
|
|
'url' => 'string'
|
|
];
|
|
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerFormats = [
|
|
'id' => 'int64',
|
|
'email' => null,
|
|
'target' => null,
|
|
'url' => 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 = [
|
|
'id' => 'id',
|
|
'email' => 'email',
|
|
'target' => 'target',
|
|
'url' => 'url'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = [
|
|
'id' => 'setId',
|
|
'email' => 'setEmail',
|
|
'target' => 'setTarget',
|
|
'url' => 'setUrl'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = [
|
|
'id' => 'getId',
|
|
'email' => 'getEmail',
|
|
'target' => 'getTarget',
|
|
'url' => 'getUrl'
|
|
];
|
|
|
|
/**
|
|
* 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 TARGET_AUTOMATION = 'automation';
|
|
const TARGET_EMAIL_CAMPAIGN = 'email_campaign';
|
|
const TARGET_CONTACTS = 'contacts';
|
|
const TARGET_LANDING_PAGES = 'landing_pages';
|
|
const TARGET_EMAIL_TRANSACTIONAL = 'email_transactional';
|
|
const TARGET_SENDERS = 'senders';
|
|
const TARGET_SMS_CAMPAIGN = 'sms_campaign';
|
|
const TARGET_SMS_TRANSACTIONAL = 'sms_transactional';
|
|
|
|
|
|
|
|
/**
|
|
* Gets allowable values of the enum
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getTargetAllowableValues()
|
|
{
|
|
return [
|
|
self::TARGET_AUTOMATION,
|
|
self::TARGET_EMAIL_CAMPAIGN,
|
|
self::TARGET_CONTACTS,
|
|
self::TARGET_LANDING_PAGES,
|
|
self::TARGET_EMAIL_TRANSACTIONAL,
|
|
self::TARGET_SENDERS,
|
|
self::TARGET_SMS_CAMPAIGN,
|
|
self::TARGET_SMS_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['id'] = isset($data['id']) ? $data['id'] : null;
|
|
$this->container['email'] = isset($data['email']) ? $data['email'] : null;
|
|
$this->container['target'] = isset($data['target']) ? $data['target'] : null;
|
|
$this->container['url'] = isset($data['url']) ? $data['url'] : 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";
|
|
}
|
|
$allowedValues = $this->getTargetAllowableValues();
|
|
if (!is_null($this->container['target']) && !in_array($this->container['target'], $allowedValues, true)) {
|
|
$invalidProperties[] = sprintf(
|
|
"invalid value for 'target', must be one of '%s'",
|
|
implode("', '", $allowedValues)
|
|
);
|
|
}
|
|
|
|
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 sub-account organization
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setId($id)
|
|
{
|
|
$this->container['id'] = $id;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets email
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getEmail()
|
|
{
|
|
return $this->container['email'];
|
|
}
|
|
|
|
/**
|
|
* Sets email
|
|
*
|
|
* @param string $email User email of sub-account organization
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setEmail($email)
|
|
{
|
|
$this->container['email'] = $email;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets target
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getTarget()
|
|
{
|
|
return $this->container['target'];
|
|
}
|
|
|
|
/**
|
|
* Sets target
|
|
*
|
|
* @param string $target Set target after login success * automation - Redirect to Automation after login * email_campaign - Redirect to Email Campaign after login * contacts - Redirect to Contacts after login * landing_pages - Redirect to Landing Pages after login * email_transactional - Redirect to Email Transactional after login * senders - Redirect to Contacts after login * sms_campaign - Redirect to Sms Campaign after login * sms_transactional - Redirect to Sms Transactional after login
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setTarget($target)
|
|
{
|
|
$allowedValues = $this->getTargetAllowableValues();
|
|
if (!is_null($target) && !in_array($target, $allowedValues, true)) {
|
|
throw new \InvalidArgumentException(
|
|
sprintf(
|
|
"Invalid value for 'target', must be one of '%s'",
|
|
implode("', '", $allowedValues)
|
|
)
|
|
);
|
|
}
|
|
$this->container['target'] = $target;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets url
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUrl()
|
|
{
|
|
return $this->container['url'];
|
|
}
|
|
|
|
/**
|
|
* Sets url
|
|
*
|
|
* @param string $url Set the full target URL after login success. The user will land directly on this target URL after login
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setUrl($url)
|
|
{
|
|
$this->container['url'] = $url;
|
|
|
|
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));
|
|
}
|
|
}
|
|
|
|
|