/home/brandsfa/public_html/vendor/xendit/xendit-php/lib/PaymentRequest/Capture.php
<?php
/**
* Capture
*
* PHP version 7.4
*
* @category Class
* @package Xendit
*/
/**
* Payment Requests
*
* The version of the OpenAPI document: 1.45.2
*/
/**
* NOTE: This class is auto generated.
* Do not edit the class manually.
*/
namespace Xendit\PaymentRequest;
use \ArrayAccess;
use \Xendit\ObjectSerializer;
use \Xendit\Model\ModelInterface;
/**
* Capture Class Doc Comment
*
* @category Class
* @package Xendit
* @implements \ArrayAccess<string, mixed>
*/
class Capture implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Capture';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'id' => 'string',
'payment_request_id' => 'string',
'payment_id' => 'string',
'reference_id' => 'string',
'currency' => 'string',
'authorized_amount' => 'float',
'captured_amount' => 'float',
'status' => 'string',
'payment_method' => '\Xendit\PaymentRequest\PaymentMethod',
'failure_code' => 'string',
'customer_id' => 'string',
'metadata' => 'object',
'channel_properties' => 'object',
'created' => 'string',
'updated' => '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 = [
'id' => null,
'payment_request_id' => null,
'payment_id' => null,
'reference_id' => null,
'currency' => null,
'authorized_amount' => 'double',
'captured_amount' => 'double',
'status' => null,
'payment_method' => null,
'failure_code' => null,
'customer_id' => null,
'metadata' => null,
'channel_properties' => null,
'created' => null,
'updated' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'id' => false,
'payment_request_id' => false,
'payment_id' => false,
'reference_id' => false,
'currency' => false,
'authorized_amount' => false,
'captured_amount' => false,
'status' => false,
'payment_method' => false,
'failure_code' => true,
'customer_id' => true,
'metadata' => true,
'channel_properties' => true,
'created' => false,
'updated' => false
];
/**
* 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 = [
'id' => 'id',
'payment_request_id' => 'payment_request_id',
'payment_id' => 'payment_id',
'reference_id' => 'reference_id',
'currency' => 'currency',
'authorized_amount' => 'authorized_amount',
'captured_amount' => 'captured_amount',
'status' => 'status',
'payment_method' => 'payment_method',
'failure_code' => 'failure_code',
'customer_id' => 'customer_id',
'metadata' => 'metadata',
'channel_properties' => 'channel_properties',
'created' => 'created',
'updated' => 'updated'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'id' => 'setId',
'payment_request_id' => 'setPaymentRequestId',
'payment_id' => 'setPaymentId',
'reference_id' => 'setReferenceId',
'currency' => 'setCurrency',
'authorized_amount' => 'setAuthorizedAmount',
'captured_amount' => 'setCapturedAmount',
'status' => 'setStatus',
'payment_method' => 'setPaymentMethod',
'failure_code' => 'setFailureCode',
'customer_id' => 'setCustomerId',
'metadata' => 'setMetadata',
'channel_properties' => 'setChannelProperties',
'created' => 'setCreated',
'updated' => 'setUpdated'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'id' => 'getId',
'payment_request_id' => 'getPaymentRequestId',
'payment_id' => 'getPaymentId',
'reference_id' => 'getReferenceId',
'currency' => 'getCurrency',
'authorized_amount' => 'getAuthorizedAmount',
'captured_amount' => 'getCapturedAmount',
'status' => 'getStatus',
'payment_method' => 'getPaymentMethod',
'failure_code' => 'getFailureCode',
'customer_id' => 'getCustomerId',
'metadata' => 'getMetadata',
'channel_properties' => 'getChannelProperties',
'created' => 'getCreated',
'updated' => 'getUpdated'
];
/**
* 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 STATUS_SUCCEEDED = 'SUCCEEDED';
public const STATUS_FAILED = 'FAILED';
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getStatusAllowableValues()
{
return [
self::STATUS_SUCCEEDED,
self::STATUS_FAILED,
];
}
/**
* 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('id', $data ?? [], null);
$this->setIfExists('payment_request_id', $data ?? [], null);
$this->setIfExists('payment_id', $data ?? [], null);
$this->setIfExists('reference_id', $data ?? [], null);
$this->setIfExists('currency', $data ?? [], null);
$this->setIfExists('authorized_amount', $data ?? [], null);
$this->setIfExists('captured_amount', $data ?? [], null);
$this->setIfExists('status', $data ?? [], null);
$this->setIfExists('payment_method', $data ?? [], null);
$this->setIfExists('failure_code', $data ?? [], null);
$this->setIfExists('customer_id', $data ?? [], null);
$this->setIfExists('metadata', $data ?? [], null);
$this->setIfExists('channel_properties', $data ?? [], null);
$this->setIfExists('created', $data ?? [], null);
$this->setIfExists('updated', $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['id'] === null) {
$invalidProperties[] = "'id' can't be null";
}
if ($this->container['payment_request_id'] === null) {
$invalidProperties[] = "'payment_request_id' can't be null";
}
if ($this->container['payment_id'] === null) {
$invalidProperties[] = "'payment_id' can't be null";
}
if ($this->container['reference_id'] === null) {
$invalidProperties[] = "'reference_id' can't be null";
}
if ($this->container['currency'] === null) {
$invalidProperties[] = "'currency' can't be null";
}
if ($this->container['authorized_amount'] === null) {
$invalidProperties[] = "'authorized_amount' can't be null";
}
if ($this->container['captured_amount'] === null) {
$invalidProperties[] = "'captured_amount' can't be null";
}
if ($this->container['status'] === null) {
$invalidProperties[] = "'status' can't be null";
}
$allowedValues = $this->getStatusAllowableValues();
if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value '%s' for 'status', must be one of '%s'",
$this->container['status'],
implode("', '", $allowedValues)
);
}
if ($this->container['payment_method'] === null) {
$invalidProperties[] = "'payment_method' can't be null";
}
if ($this->container['failure_code'] === null) {
$invalidProperties[] = "'failure_code' can't be null";
}
if ($this->container['customer_id'] === null) {
$invalidProperties[] = "'customer_id' can't be null";
}
if ($this->container['metadata'] === null) {
$invalidProperties[] = "'metadata' can't be null";
}
if ($this->container['channel_properties'] === null) {
$invalidProperties[] = "'channel_properties' can't be null";
}
if ($this->container['created'] === null) {
$invalidProperties[] = "'created' can't be null";
}
if ($this->container['updated'] === null) {
$invalidProperties[] = "'updated' 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 id
*
* @return string
*/
public function getId()
{
return $this->container['id'];
}
/**
* Sets id
*
* @param string $id id
*
* @return self
*/
public function setId($id)
{
if (is_null($id)) {
throw new \InvalidArgumentException('non-nullable id cannot be null');
}
$this->container['id'] = $id;
return $this;
}
/**
* Gets payment_request_id
*
* @return string
*/
public function getPaymentRequestId()
{
return $this->container['payment_request_id'];
}
/**
* Sets payment_request_id
*
* @param string $payment_request_id payment_request_id
*
* @return self
*/
public function setPaymentRequestId($payment_request_id)
{
if (is_null($payment_request_id)) {
throw new \InvalidArgumentException('non-nullable payment_request_id cannot be null');
}
$this->container['payment_request_id'] = $payment_request_id;
return $this;
}
/**
* Gets payment_id
*
* @return string
*/
public function getPaymentId()
{
return $this->container['payment_id'];
}
/**
* Sets payment_id
*
* @param string $payment_id payment_id
*
* @return self
*/
public function setPaymentId($payment_id)
{
if (is_null($payment_id)) {
throw new \InvalidArgumentException('non-nullable payment_id cannot be null');
}
$this->container['payment_id'] = $payment_id;
return $this;
}
/**
* Gets reference_id
*
* @return string
*/
public function getReferenceId()
{
return $this->container['reference_id'];
}
/**
* Sets reference_id
*
* @param string $reference_id reference_id
*
* @return self
*/
public function setReferenceId($reference_id)
{
if (is_null($reference_id)) {
throw new \InvalidArgumentException('non-nullable reference_id cannot be null');
}
$this->container['reference_id'] = $reference_id;
return $this;
}
/**
* Gets currency
*
* @return string
*/
public function getCurrency()
{
return $this->container['currency'];
}
/**
* Sets currency
*
* @param string $currency currency
*
* @return self
*/
public function setCurrency($currency)
{
if (is_null($currency)) {
throw new \InvalidArgumentException('non-nullable currency cannot be null');
}
$this->container['currency'] = $currency;
return $this;
}
/**
* Gets authorized_amount
*
* @return float
*/
public function getAuthorizedAmount()
{
return $this->container['authorized_amount'];
}
/**
* Sets authorized_amount
*
* @param float $authorized_amount authorized_amount
*
* @return self
*/
public function setAuthorizedAmount($authorized_amount)
{
if (is_null($authorized_amount)) {
throw new \InvalidArgumentException('non-nullable authorized_amount cannot be null');
}
$this->container['authorized_amount'] = $authorized_amount;
return $this;
}
/**
* Gets captured_amount
*
* @return float
*/
public function getCapturedAmount()
{
return $this->container['captured_amount'];
}
/**
* Sets captured_amount
*
* @param float $captured_amount captured_amount
*
* @return self
*/
public function setCapturedAmount($captured_amount)
{
if (is_null($captured_amount)) {
throw new \InvalidArgumentException('non-nullable captured_amount cannot be null');
}
$this->container['captured_amount'] = $captured_amount;
return $this;
}
/**
* Gets status
*
* @return string
*/
public function getStatus()
{
return $this->container['status'];
}
/**
* Sets status
*
* @param string $status status
*
* @return self
*/
public function setStatus($status)
{
if (is_null($status)) {
throw new \InvalidArgumentException('non-nullable status cannot be null');
}
$allowedValues = $this->getStatusAllowableValues();
if (!in_array($status, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value '%s' for 'status', must be one of '%s'",
$status,
implode("', '", $allowedValues)
)
);
}
$this->container['status'] = $status;
return $this;
}
/**
* Gets payment_method
*
* @return \PaymentRequest\PaymentMethod
*/
public function getPaymentMethod()
{
return $this->container['payment_method'];
}
/**
* Sets payment_method
*
* @param \PaymentRequest\PaymentMethod $payment_method payment_method
*
* @return self
*/
public function setPaymentMethod($payment_method)
{
if (is_null($payment_method)) {
throw new \InvalidArgumentException('non-nullable payment_method cannot be null');
}
$this->container['payment_method'] = $payment_method;
return $this;
}
/**
* Gets failure_code
*
* @return string
*/
public function getFailureCode()
{
return $this->container['failure_code'];
}
/**
* Sets failure_code
*
* @param string $failure_code failure_code
*
* @return self
*/
public function setFailureCode($failure_code)
{
if (is_null($failure_code)) {
array_push($this->openAPINullablesSetToNull, 'failure_code');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('failure_code', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['failure_code'] = $failure_code;
return $this;
}
/**
* Gets customer_id
*
* @return string
*/
public function getCustomerId()
{
return $this->container['customer_id'];
}
/**
* Sets customer_id
*
* @param string $customer_id customer_id
*
* @return self
*/
public function setCustomerId($customer_id)
{
if (is_null($customer_id)) {
array_push($this->openAPINullablesSetToNull, 'customer_id');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('customer_id', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['customer_id'] = $customer_id;
return $this;
}
/**
* Gets metadata
*
* @return object
*/
public function getMetadata()
{
return $this->container['metadata'];
}
/**
* Sets metadata
*
* @param object $metadata metadata
*
* @return self
*/
public function setMetadata($metadata)
{
if (is_null($metadata)) {
array_push($this->openAPINullablesSetToNull, 'metadata');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('metadata', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['metadata'] = $metadata;
return $this;
}
/**
* Gets channel_properties
*
* @return object
*/
public function getChannelProperties()
{
return $this->container['channel_properties'];
}
/**
* Sets channel_properties
*
* @param object $channel_properties channel_properties
*
* @return self
*/
public function setChannelProperties($channel_properties)
{
if (is_null($channel_properties)) {
array_push($this->openAPINullablesSetToNull, 'channel_properties');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('channel_properties', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['channel_properties'] = $channel_properties;
return $this;
}
/**
* Gets created
*
* @return string
*/
public function getCreated()
{
return $this->container['created'];
}
/**
* Sets created
*
* @param string $created created
*
* @return self
*/
public function setCreated($created)
{
if (is_null($created)) {
throw new \InvalidArgumentException('non-nullable created cannot be null');
}
$this->container['created'] = $created;
return $this;
}
/**
* Gets updated
*
* @return string
*/
public function getUpdated()
{
return $this->container['updated'];
}
/**
* Sets updated
*
* @param string $updated updated
*
* @return self
*/
public function setUpdated($updated)
{
if (is_null($updated)) {
throw new \InvalidArgumentException('non-nullable updated cannot be null');
}
$this->container['updated'] = $updated;
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));
}
}