MIF_E31211285/vendor/xendit/xendit-php/lib/PaymentRequest/PaymentRequestAction.php

653 lines
16 KiB
PHP

<?php
/**
* PaymentRequestAction
*
* PHP version 7.4
*
* @category Class
* @package Xendit
*/
/**
* Payment Requests
*
* The version of the OpenAPI document: 1.59.0
*/
/**
* NOTE: This class is auto generated.
* Do not edit the class manually.
*/
namespace Xendit\PaymentRequest;
use \ArrayAccess;
use \Xendit\ObjectSerializer;
use \Xendit\Model\ModelInterface;
/**
* PaymentRequestAction Class Doc Comment
*
* @category Class
* @package Xendit
* @implements \ArrayAccess<string, mixed>
*/
class PaymentRequestAction implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'PaymentRequestAction';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'action' => 'string',
'url_type' => 'string',
'method' => 'string',
'url' => 'string',
'qr_code' => 'string'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var string[]
* @phpstan-var array<string, string|null>
* @psalm-var array<string, string|null>
*/
protected static $openAPIFormats = [
'action' => null,
'url_type' => null,
'method' => null,
'url' => null,
'qr_code' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'action' => false,
'url_type' => false,
'method' => true,
'url' => true,
'qr_code' => true
];
/**
* If a nullable field gets set to null, insert it here
*
* @var boolean[]
*/
protected array $openAPINullablesSetToNull = [];
/**
* Array of property to type mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPITypes()
{
return self::$openAPITypes;
}
/**
* Array of property to format mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPIFormats()
{
return self::$openAPIFormats;
}
/**
* Array of nullable properties
*
* @return array
*/
protected static function openAPINullables(): array
{
return self::$openAPINullables;
}
/**
* Array of nullable field names deliberately set to null
*
* @return boolean[]
*/
private function getOpenAPINullablesSetToNull(): array
{
return $this->openAPINullablesSetToNull;
}
/**
* Setter - Array of nullable field names deliberately set to null
*
* @param boolean[] $openAPINullablesSetToNull
*/
private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
{
$this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
}
/**
* Checks if a property is nullable
*
* @param string $property
* @return bool
*/
public static function isNullable(string $property): bool
{
return self::openAPINullables()[$property] ?? false;
}
/**
* Checks if a nullable property is set to null.
*
* @param string $property
* @return bool
*/
public function isNullableSetToNull(string $property): bool
{
return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
}
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @var string[]
*/
protected static $attributeMap = [
'action' => 'action',
'url_type' => 'url_type',
'method' => 'method',
'url' => 'url',
'qr_code' => 'qr_code'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'action' => 'setAction',
'url_type' => 'setUrlType',
'method' => 'setMethod',
'url' => 'setUrl',
'qr_code' => 'setQrCode'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'action' => 'getAction',
'url_type' => 'getUrlType',
'method' => 'getMethod',
'url' => 'getUrl',
'qr_code' => 'getQrCode'
];
/**
* 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::$openAPIModelName;
}
public const ACTION_AUTH = 'AUTH';
public const ACTION_RESEND_AUTH = 'RESEND_AUTH';
public const ACTION_CAPTURE = 'CAPTURE';
public const ACTION_CANCEL = 'CANCEL';
public const ACTION_PRESENT_TO_CUSTOMER = 'PRESENT_TO_CUSTOMER';
public const URL_TYPE_API = 'API';
public const URL_TYPE_WEB = 'WEB';
public const URL_TYPE_MOBILE = 'MOBILE';
public const URL_TYPE_DEEPLINK = 'DEEPLINK';
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getActionAllowableValues()
{
return [
self::ACTION_AUTH,
self::ACTION_RESEND_AUTH,
self::ACTION_CAPTURE,
self::ACTION_CANCEL,
self::ACTION_PRESENT_TO_CUSTOMER,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getUrlTypeAllowableValues()
{
return [
self::URL_TYPE_API,
self::URL_TYPE_WEB,
self::URL_TYPE_MOBILE,
self::URL_TYPE_DEEPLINK,
];
}
/**
* 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->setIfExists('action', $data ?? [], null);
$this->setIfExists('url_type', $data ?? [], null);
$this->setIfExists('method', $data ?? [], null);
$this->setIfExists('url', $data ?? [], null);
$this->setIfExists('qr_code', $data ?? [], null);
}
/**
* Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
* is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
* $this->openAPINullablesSetToNull array
*
* @param string $variableName
* @param array $fields
* @param mixed $defaultValue
*/
private function setIfExists(string $variableName, array $fields, $defaultValue): void
{
if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
$this->openAPINullablesSetToNull[] = $variableName;
}
$this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
}
/**
* Show all the invalid properties with reasons.
*
* @return array invalid properties with reasons
*/
public function listInvalidProperties()
{
$invalidProperties = [];
if ($this->container['action'] === null) {
$invalidProperties[] = "'action' can't be null";
}
$allowedValues = $this->getActionAllowableValues();
if (!is_null($this->container['action']) && !in_array($this->container['action'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value '%s' for 'action', must be one of '%s'",
$this->container['action'],
implode("', '", $allowedValues)
);
}
if ($this->container['url_type'] === null) {
$invalidProperties[] = "'url_type' can't be null";
}
$allowedValues = $this->getUrlTypeAllowableValues();
if (!is_null($this->container['url_type']) && !in_array($this->container['url_type'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value '%s' for 'url_type', must be one of '%s'",
$this->container['url_type'],
implode("', '", $allowedValues)
);
}
if ($this->container['method'] === null) {
$invalidProperties[] = "'method' can't be null";
}
if ($this->container['url'] === null) {
$invalidProperties[] = "'url' can't be null";
}
if ($this->container['qr_code'] === null) {
$invalidProperties[] = "'qr_code' 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 action
*
* @return string
*/
public function getAction()
{
return $this->container['action'];
}
/**
* Sets action
*
* @param string $action action
*
* @return self
*/
public function setAction($action)
{
if (is_null($action)) {
throw new \InvalidArgumentException('non-nullable action cannot be null');
}
$allowedValues = $this->getActionAllowableValues();
if (!in_array($action, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value '%s' for 'action', must be one of '%s'",
$action,
implode("', '", $allowedValues)
)
);
}
$this->container['action'] = $action;
return $this;
}
/**
* Gets url_type
*
* @return string
*/
public function getUrlType()
{
return $this->container['url_type'];
}
/**
* Sets url_type
*
* @param string $url_type url_type
*
* @return self
*/
public function setUrlType($url_type)
{
if (is_null($url_type)) {
throw new \InvalidArgumentException('non-nullable url_type cannot be null');
}
$allowedValues = $this->getUrlTypeAllowableValues();
if (!in_array($url_type, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value '%s' for 'url_type', must be one of '%s'",
$url_type,
implode("', '", $allowedValues)
)
);
}
$this->container['url_type'] = $url_type;
return $this;
}
/**
* Gets method
*
* @return string
*/
public function getMethod()
{
return $this->container['method'];
}
/**
* Sets method
*
* @param string $method method
*
* @return self
*/
public function setMethod($method)
{
if (is_null($method)) {
array_push($this->openAPINullablesSetToNull, 'method');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('method', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['method'] = $method;
return $this;
}
/**
* Gets url
*
* @return string
*/
public function getUrl()
{
return $this->container['url'];
}
/**
* Sets url
*
* @param string $url url
*
* @return self
*/
public function setUrl($url)
{
if (is_null($url)) {
array_push($this->openAPINullablesSetToNull, 'url');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('url', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['url'] = $url;
return $this;
}
/**
* Gets qr_code
*
* @return string
*/
public function getQrCode()
{
return $this->container['qr_code'];
}
/**
* Sets qr_code
*
* @param string $qr_code qr_code
*
* @return self
*/
public function setQrCode($qr_code)
{
if (is_null($qr_code)) {
array_push($this->openAPINullablesSetToNull, 'qr_code');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('qr_code', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['qr_code'] = $qr_code;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param integer $offset Offset
*
* @return boolean
*/
public function offsetExists($offset): bool
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param integer $offset Offset
*
* @return mixed|null
*/
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return $this->container[$offset] ?? null;
}
/**
* Sets value based on offset.
*
* @param int|null $offset Offset
* @param mixed $value Value to be set
*
* @return void
*/
public function offsetSet($offset, $value): void
{
if (is_null($offset)) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
/**
* Unsets offset.
*
* @param integer $offset Offset
*
* @return void
*/
public function offsetUnset($offset): void
{
unset($this->container[$offset]);
}
/**
* Serializes the object to a value that can be serialized natively by json_encode().
* @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php
*
* @return mixed Returns data which can be serialized by json_encode(), which is a value
* of any type other than a resource.
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return ObjectSerializer::sanitizeForSerialization($this);
}
/**
* Gets the string presentation of the object
*
* @return string
*/
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}