MIF_E31211285/vendor/xendit/xendit-php/lib/Invoice/CustomerObject.php

698 lines
17 KiB
PHP

<?php
/**
* CustomerObject
*
* PHP version 7.4
*
* @category Class
* @package Xendit
*/
/**
* xendit-invoice-service
*
* The version of the OpenAPI document: 1.7.6
*/
/**
* NOTE: This class is auto generated.
* Do not edit the class manually.
*/
namespace Xendit\Invoice;
use \ArrayAccess;
use \Xendit\ObjectSerializer;
use \Xendit\Model\ModelInterface;
/**
* CustomerObject Class Doc Comment
*
* @category Class
* @description An object representing a customer with various properties, including addresses.
* @package Xendit
* @implements \ArrayAccess<string, mixed>
*/
class CustomerObject implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'CustomerObject';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'id' => 'string',
'phone_number' => 'string',
'given_names' => 'string',
'surname' => 'string',
'email' => 'string',
'mobile_number' => 'string',
'customer_id' => 'string',
'addresses' => '\Xendit\Invoice\AddressObject[]'
];
/**
* 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,
'phone_number' => null,
'given_names' => null,
'surname' => null,
'email' => null,
'mobile_number' => null,
'customer_id' => null,
'addresses' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'id' => true,
'phone_number' => true,
'given_names' => true,
'surname' => true,
'email' => true,
'mobile_number' => true,
'customer_id' => true,
'addresses' => 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 = [
'id' => 'id',
'phone_number' => 'phone_number',
'given_names' => 'given_names',
'surname' => 'surname',
'email' => 'email',
'mobile_number' => 'mobile_number',
'customer_id' => 'customer_id',
'addresses' => 'addresses'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'id' => 'setId',
'phone_number' => 'setPhoneNumber',
'given_names' => 'setGivenNames',
'surname' => 'setSurname',
'email' => 'setEmail',
'mobile_number' => 'setMobileNumber',
'customer_id' => 'setCustomerId',
'addresses' => 'setAddresses'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'id' => 'getId',
'phone_number' => 'getPhoneNumber',
'given_names' => 'getGivenNames',
'surname' => 'getSurname',
'email' => 'getEmail',
'mobile_number' => 'getMobileNumber',
'customer_id' => 'getCustomerId',
'addresses' => 'getAddresses'
];
/**
* 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('id', $data ?? [], null);
$this->setIfExists('phone_number', $data ?? [], null);
$this->setIfExists('given_names', $data ?? [], null);
$this->setIfExists('surname', $data ?? [], null);
$this->setIfExists('email', $data ?? [], null);
$this->setIfExists('mobile_number', $data ?? [], null);
$this->setIfExists('customer_id', $data ?? [], null);
$this->setIfExists('addresses', $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 = [];
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|null
*/
public function getId()
{
return $this->container['id'];
}
/**
* Sets id
*
* @param string|null $id The unique identifier for the customer.
*
* @return self
*/
public function setId($id)
{
if (is_null($id)) {
array_push($this->openAPINullablesSetToNull, 'id');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('id', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['id'] = $id;
return $this;
}
/**
* Gets phone_number
*
* @return string|null
*/
public function getPhoneNumber()
{
return $this->container['phone_number'];
}
/**
* Sets phone_number
*
* @param string|null $phone_number The customer's phone number.
*
* @return self
*/
public function setPhoneNumber($phone_number)
{
if (is_null($phone_number)) {
array_push($this->openAPINullablesSetToNull, 'phone_number');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('phone_number', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['phone_number'] = $phone_number;
return $this;
}
/**
* Gets given_names
*
* @return string|null
*/
public function getGivenNames()
{
return $this->container['given_names'];
}
/**
* Sets given_names
*
* @param string|null $given_names The customer's given names or first names.
*
* @return self
*/
public function setGivenNames($given_names)
{
if (is_null($given_names)) {
array_push($this->openAPINullablesSetToNull, 'given_names');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('given_names', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['given_names'] = $given_names;
return $this;
}
/**
* Gets surname
*
* @return string|null
*/
public function getSurname()
{
return $this->container['surname'];
}
/**
* Sets surname
*
* @param string|null $surname The customer's surname or last name.
*
* @return self
*/
public function setSurname($surname)
{
if (is_null($surname)) {
array_push($this->openAPINullablesSetToNull, 'surname');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('surname', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['surname'] = $surname;
return $this;
}
/**
* Gets email
*
* @return string|null
*/
public function getEmail()
{
return $this->container['email'];
}
/**
* Sets email
*
* @param string|null $email The customer's email address.
*
* @return self
*/
public function setEmail($email)
{
if (is_null($email)) {
array_push($this->openAPINullablesSetToNull, 'email');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('email', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['email'] = $email;
return $this;
}
/**
* Gets mobile_number
*
* @return string|null
*/
public function getMobileNumber()
{
return $this->container['mobile_number'];
}
/**
* Sets mobile_number
*
* @param string|null $mobile_number The customer's mobile phone number.
*
* @return self
*/
public function setMobileNumber($mobile_number)
{
if (is_null($mobile_number)) {
array_push($this->openAPINullablesSetToNull, 'mobile_number');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('mobile_number', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['mobile_number'] = $mobile_number;
return $this;
}
/**
* Gets customer_id
*
* @return string|null
*/
public function getCustomerId()
{
return $this->container['customer_id'];
}
/**
* Sets customer_id
*
* @param string|null $customer_id An additional identifier for the customer.
*
* @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 addresses
*
* @return \Invoice\AddressObject[]|null
*/
public function getAddresses()
{
return $this->container['addresses'];
}
/**
* Sets addresses
*
* @param \Invoice\AddressObject[]|null $addresses An array of addresses associated with the customer.
*
* @return self
*/
public function setAddresses($addresses)
{
if (is_null($addresses)) {
array_push($this->openAPINullablesSetToNull, 'addresses');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('addresses', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['addresses'] = $addresses;
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));
}
}