427 lines
11 KiB
PHP
427 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* UpdateWhatsAppCampaign
|
|
*
|
|
* 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;
|
|
|
|
/**
|
|
* UpdateWhatsAppCampaign Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package Brevo\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class UpdateWhatsAppCampaign implements ModelInterface, ArrayAccess
|
|
{
|
|
const DISCRIMINATOR = null;
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $swaggerModelName = 'updateWhatsAppCampaign';
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerTypes = [
|
|
'campaignName' => 'string',
|
|
'campaignStatus' => 'string',
|
|
'rescheduleFor' => 'string',
|
|
'recipients' => '\Brevo\Client\Model\CreateWhatsAppCampaignRecipients'
|
|
];
|
|
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerFormats = [
|
|
'campaignName' => null,
|
|
'campaignStatus' => null,
|
|
'rescheduleFor' => null,
|
|
'recipients' => 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 = [
|
|
'campaignName' => 'campaignName',
|
|
'campaignStatus' => 'campaignStatus',
|
|
'rescheduleFor' => 'rescheduleFor',
|
|
'recipients' => 'recipients'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = [
|
|
'campaignName' => 'setCampaignName',
|
|
'campaignStatus' => 'setCampaignStatus',
|
|
'rescheduleFor' => 'setRescheduleFor',
|
|
'recipients' => 'setRecipients'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = [
|
|
'campaignName' => 'getCampaignName',
|
|
'campaignStatus' => 'getCampaignStatus',
|
|
'rescheduleFor' => 'getRescheduleFor',
|
|
'recipients' => 'getRecipients'
|
|
];
|
|
|
|
/**
|
|
* 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 CAMPAIGN_STATUS_SCHEDULED = 'scheduled';
|
|
const CAMPAIGN_STATUS_SUSPENDED = 'suspended';
|
|
|
|
|
|
|
|
/**
|
|
* Gets allowable values of the enum
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getCampaignStatusAllowableValues()
|
|
{
|
|
return [
|
|
self::CAMPAIGN_STATUS_SCHEDULED,
|
|
self::CAMPAIGN_STATUS_SUSPENDED,
|
|
];
|
|
}
|
|
|
|
|
|
/**
|
|
* 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['campaignName'] = isset($data['campaignName']) ? $data['campaignName'] : null;
|
|
$this->container['campaignStatus'] = isset($data['campaignStatus']) ? $data['campaignStatus'] : 'scheduled';
|
|
$this->container['rescheduleFor'] = isset($data['rescheduleFor']) ? $data['rescheduleFor'] : null;
|
|
$this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null;
|
|
}
|
|
|
|
/**
|
|
* Show all the invalid properties with reasons.
|
|
*
|
|
* @return array invalid properties with reasons
|
|
*/
|
|
public function listInvalidProperties()
|
|
{
|
|
$invalidProperties = [];
|
|
|
|
$allowedValues = $this->getCampaignStatusAllowableValues();
|
|
if (!is_null($this->container['campaignStatus']) && !in_array($this->container['campaignStatus'], $allowedValues, true)) {
|
|
$invalidProperties[] = sprintf(
|
|
"invalid value for 'campaignStatus', 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 campaignName
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCampaignName()
|
|
{
|
|
return $this->container['campaignName'];
|
|
}
|
|
|
|
/**
|
|
* Sets campaignName
|
|
*
|
|
* @param string $campaignName Name of the campaign
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setCampaignName($campaignName)
|
|
{
|
|
$this->container['campaignName'] = $campaignName;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets campaignStatus
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCampaignStatus()
|
|
{
|
|
return $this->container['campaignStatus'];
|
|
}
|
|
|
|
/**
|
|
* Sets campaignStatus
|
|
*
|
|
* @param string $campaignStatus Status of the campaign
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setCampaignStatus($campaignStatus)
|
|
{
|
|
$allowedValues = $this->getCampaignStatusAllowableValues();
|
|
if (!is_null($campaignStatus) && !in_array($campaignStatus, $allowedValues, true)) {
|
|
throw new \InvalidArgumentException(
|
|
sprintf(
|
|
"Invalid value for 'campaignStatus', must be one of '%s'",
|
|
implode("', '", $allowedValues)
|
|
)
|
|
);
|
|
}
|
|
$this->container['campaignStatus'] = $campaignStatus;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets rescheduleFor
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getRescheduleFor()
|
|
{
|
|
return $this->container['rescheduleFor'];
|
|
}
|
|
|
|
/**
|
|
* Sets rescheduleFor
|
|
*
|
|
* @param string $rescheduleFor Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setRescheduleFor($rescheduleFor)
|
|
{
|
|
$this->container['rescheduleFor'] = $rescheduleFor;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets recipients
|
|
*
|
|
* @return \Brevo\Client\Model\CreateWhatsAppCampaignRecipients
|
|
*/
|
|
public function getRecipients()
|
|
{
|
|
return $this->container['recipients'];
|
|
}
|
|
|
|
/**
|
|
* Sets recipients
|
|
*
|
|
* @param \Brevo\Client\Model\CreateWhatsAppCampaignRecipients $recipients recipients
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setRecipients($recipients)
|
|
{
|
|
$this->container['recipients'] = $recipients;
|
|
|
|
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));
|
|
}
|
|
}
|
|
|
|
|