/home/brandsfa/public_html/vendor/xendit/xendit-php/lib/PaymentRequest/PaymentRequestParameters.php
<?php
/**
* PaymentRequestParameters
*
* 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;
/**
* PaymentRequestParameters Class Doc Comment
*
* @category Class
* @package Xendit
* @implements \ArrayAccess<string, mixed>
*/
class PaymentRequestParameters implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'PaymentRequestParameters';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'reference_id' => 'string',
'amount' => 'float',
'currency' => '\Xendit\PaymentRequest\PaymentRequestCurrency',
'payment_method' => '\Xendit\PaymentRequest\PaymentMethodParameters',
'description' => 'string',
'capture_method' => '\Xendit\PaymentRequest\PaymentRequestCaptureMethod',
'initiator' => '\Xendit\PaymentRequest\PaymentRequestInitiator',
'payment_method_id' => 'string',
'channel_properties' => '\Xendit\PaymentRequest\PaymentRequestParametersChannelProperties',
'shipping_information' => '\Xendit\PaymentRequest\PaymentRequestShippingInformation',
'items' => '\Xendit\PaymentRequest\PaymentRequestBasketItem[]',
'customer_id' => 'string',
'customer' => 'object',
'metadata' => 'object'
];
/**
* 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 = [
'reference_id' => null,
'amount' => 'double',
'currency' => null,
'payment_method' => null,
'description' => null,
'capture_method' => null,
'initiator' => null,
'payment_method_id' => null,
'channel_properties' => null,
'shipping_information' => null,
'items' => null,
'customer_id' => null,
'customer' => null,
'metadata' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'reference_id' => false,
'amount' => false,
'currency' => false,
'payment_method' => false,
'description' => true,
'capture_method' => true,
'initiator' => true,
'payment_method_id' => false,
'channel_properties' => false,
'shipping_information' => true,
'items' => true,
'customer_id' => true,
'customer' => true,
'metadata' => 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 = [
'reference_id' => 'reference_id',
'amount' => 'amount',
'currency' => 'currency',
'payment_method' => 'payment_method',
'description' => 'description',
'capture_method' => 'capture_method',
'initiator' => 'initiator',
'payment_method_id' => 'payment_method_id',
'channel_properties' => 'channel_properties',
'shipping_information' => 'shipping_information',
'items' => 'items',
'customer_id' => 'customer_id',
'customer' => 'customer',
'metadata' => 'metadata'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'reference_id' => 'setReferenceId',
'amount' => 'setAmount',
'currency' => 'setCurrency',
'payment_method' => 'setPaymentMethod',
'description' => 'setDescription',
'capture_method' => 'setCaptureMethod',
'initiator' => 'setInitiator',
'payment_method_id' => 'setPaymentMethodId',
'channel_properties' => 'setChannelProperties',
'shipping_information' => 'setShippingInformation',
'items' => 'setItems',
'customer_id' => 'setCustomerId',
'customer' => 'setCustomer',
'metadata' => 'setMetadata'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'reference_id' => 'getReferenceId',
'amount' => 'getAmount',
'currency' => 'getCurrency',
'payment_method' => 'getPaymentMethod',
'description' => 'getDescription',
'capture_method' => 'getCaptureMethod',
'initiator' => 'getInitiator',
'payment_method_id' => 'getPaymentMethodId',
'channel_properties' => 'getChannelProperties',
'shipping_information' => 'getShippingInformation',
'items' => 'getItems',
'customer_id' => 'getCustomerId',
'customer' => 'getCustomer',
'metadata' => 'getMetadata'
];
/**
* 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;
}
/**
* 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('reference_id', $data ?? [], null);
$this->setIfExists('amount', $data ?? [], null);
$this->setIfExists('currency', $data ?? [], null);
$this->setIfExists('payment_method', $data ?? [], null);
$this->setIfExists('description', $data ?? [], null);
$this->setIfExists('capture_method', $data ?? [], null);
$this->setIfExists('initiator', $data ?? [], null);
$this->setIfExists('payment_method_id', $data ?? [], null);
$this->setIfExists('channel_properties', $data ?? [], null);
$this->setIfExists('shipping_information', $data ?? [], null);
$this->setIfExists('items', $data ?? [], null);
$this->setIfExists('customer_id', $data ?? [], null);
$this->setIfExists('customer', $data ?? [], null);
$this->setIfExists('metadata', $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['currency'] === null) {
$invalidProperties[] = "'currency' 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 reference_id
*
* @return string|null
*/
public function getReferenceId()
{
return $this->container['reference_id'];
}
/**
* Sets reference_id
*
* @param string|null $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 amount
*
* @return float|null
*/
public function getAmount()
{
return $this->container['amount'];
}
/**
* Sets amount
*
* @param float|null $amount amount
*
* @return self
*/
public function setAmount($amount)
{
if (is_null($amount)) {
throw new \InvalidArgumentException('non-nullable amount cannot be null');
}
$this->container['amount'] = $amount;
return $this;
}
/**
* Gets currency
*
* @return \PaymentRequest\PaymentRequestCurrency
*/
public function getCurrency()
{
return $this->container['currency'];
}
/**
* Sets currency
*
* @param \PaymentRequest\PaymentRequestCurrency $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 payment_method
*
* @return \PaymentRequest\PaymentMethodParameters|null
*/
public function getPaymentMethod()
{
return $this->container['payment_method'];
}
/**
* Sets payment_method
*
* @param \PaymentRequest\PaymentMethodParameters|null $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 description
*
* @return string|null
*/
public function getDescription()
{
return $this->container['description'];
}
/**
* Sets description
*
* @param string|null $description description
*
* @return self
*/
public function setDescription($description)
{
if (is_null($description)) {
array_push($this->openAPINullablesSetToNull, 'description');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('description', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['description'] = $description;
return $this;
}
/**
* Gets capture_method
*
* @return \PaymentRequest\PaymentRequestCaptureMethod|null
*/
public function getCaptureMethod()
{
return $this->container['capture_method'];
}
/**
* Sets capture_method
*
* @param \PaymentRequest\PaymentRequestCaptureMethod|null $capture_method capture_method
*
* @return self
*/
public function setCaptureMethod($capture_method)
{
if (is_null($capture_method)) {
array_push($this->openAPINullablesSetToNull, 'capture_method');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('capture_method', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['capture_method'] = $capture_method;
return $this;
}
/**
* Gets initiator
*
* @return \PaymentRequest\PaymentRequestInitiator|null
*/
public function getInitiator()
{
return $this->container['initiator'];
}
/**
* Sets initiator
*
* @param \PaymentRequest\PaymentRequestInitiator|null $initiator initiator
*
* @return self
*/
public function setInitiator($initiator)
{
if (is_null($initiator)) {
array_push($this->openAPINullablesSetToNull, 'initiator');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('initiator', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['initiator'] = $initiator;
return $this;
}
/**
* Gets payment_method_id
*
* @return string|null
*/
public function getPaymentMethodId()
{
return $this->container['payment_method_id'];
}
/**
* Sets payment_method_id
*
* @param string|null $payment_method_id payment_method_id
*
* @return self
*/
public function setPaymentMethodId($payment_method_id)
{
if (is_null($payment_method_id)) {
throw new \InvalidArgumentException('non-nullable payment_method_id cannot be null');
}
$this->container['payment_method_id'] = $payment_method_id;
return $this;
}
/**
* Gets channel_properties
*
* @return \PaymentRequest\PaymentRequestParametersChannelProperties|null
*/
public function getChannelProperties()
{
return $this->container['channel_properties'];
}
/**
* Sets channel_properties
*
* @param \PaymentRequest\PaymentRequestParametersChannelProperties|null $channel_properties channel_properties
*
* @return self
*/
public function setChannelProperties($channel_properties)
{
if (is_null($channel_properties)) {
throw new \InvalidArgumentException('non-nullable channel_properties cannot be null');
}
$this->container['channel_properties'] = $channel_properties;
return $this;
}
/**
* Gets shipping_information
*
* @return \PaymentRequest\PaymentRequestShippingInformation|null
*/
public function getShippingInformation()
{
return $this->container['shipping_information'];
}
/**
* Sets shipping_information
*
* @param \PaymentRequest\PaymentRequestShippingInformation|null $shipping_information shipping_information
*
* @return self
*/
public function setShippingInformation($shipping_information)
{
if (is_null($shipping_information)) {
array_push($this->openAPINullablesSetToNull, 'shipping_information');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('shipping_information', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['shipping_information'] = $shipping_information;
return $this;
}
/**
* Gets items
*
* @return \PaymentRequest\PaymentRequestBasketItem[]|null
*/
public function getItems()
{
return $this->container['items'];
}
/**
* Sets items
*
* @param \PaymentRequest\PaymentRequestBasketItem[]|null $items items
*
* @return self
*/
public function setItems($items)
{
if (is_null($items)) {
array_push($this->openAPINullablesSetToNull, 'items');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('items', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['items'] = $items;
return $this;
}
/**
* Gets customer_id
*
* @return string|null
*/
public function getCustomerId()
{
return $this->container['customer_id'];
}
/**
* Sets customer_id
*
* @param string|null $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 customer
*
* @return object|null
*/
public function getCustomer()
{
return $this->container['customer'];
}
/**
* Sets customer
*
* @param object|null $customer customer
*
* @return self
*/
public function setCustomer($customer)
{
if (is_null($customer)) {
array_push($this->openAPINullablesSetToNull, 'customer');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('customer', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['customer'] = $customer;
return $this;
}
/**
* Gets metadata
*
* @return object|null
*/
public function getMetadata()
{
return $this->container['metadata'];
}
/**
* Sets metadata
*
* @param object|null $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;
}
/**
* 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));
}
}