/home/brandsfa/public_html/vendor/xendit/xendit-php/lib/Customer/AddressRequest.php
<?php
/**
* AddressRequest
*
* PHP version 7.4
*
* @category Class
* @package Xendit
*/
/**
* XENDIT SDK openapi spec
*
* The version of the OpenAPI document: 1.0.0
*/
/**
* NOTE: This class is auto generated.
* Do not edit the class manually.
*/
namespace Xendit\Customer;
use \ArrayAccess;
use \Xendit\ObjectSerializer;
use \Xendit\Model\ModelInterface;
/**
* AddressRequest Class Doc Comment
*
* @category Class
* @package Xendit
* @implements \ArrayAccess<string, mixed>
*/
class AddressRequest implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'AddressRequest';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'category' => 'string',
'country_code' => 'string',
'province_state' => 'string',
'city' => 'string',
'suburb' => 'string',
'postal_code' => 'string',
'line_1' => 'string',
'line_2' => 'string',
'status' => '\Xendit\Customer\AddressStatus',
'is_primary' => 'bool'
];
/**
* 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 = [
'category' => null,
'country_code' => null,
'province_state' => null,
'city' => null,
'suburb' => null,
'postal_code' => null,
'line_1' => null,
'line_2' => null,
'status' => null,
'is_primary' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'category' => false,
'country_code' => true,
'province_state' => false,
'city' => false,
'suburb' => false,
'postal_code' => false,
'line_1' => false,
'line_2' => false,
'status' => true,
'is_primary' => 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 = [
'category' => 'category',
'country_code' => 'country_code',
'province_state' => 'province_state',
'city' => 'city',
'suburb' => 'suburb',
'postal_code' => 'postal_code',
'line_1' => 'line_1',
'line_2' => 'line_2',
'status' => 'status',
'is_primary' => 'is_primary'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'category' => 'setCategory',
'country_code' => 'setCountryCode',
'province_state' => 'setProvinceState',
'city' => 'setCity',
'suburb' => 'setSuburb',
'postal_code' => 'setPostalCode',
'line_1' => 'setLine1',
'line_2' => 'setLine2',
'status' => 'setStatus',
'is_primary' => 'setIsPrimary'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'category' => 'getCategory',
'country_code' => 'getCountryCode',
'province_state' => 'getProvinceState',
'city' => 'getCity',
'suburb' => 'getSuburb',
'postal_code' => 'getPostalCode',
'line_1' => 'getLine1',
'line_2' => 'getLine2',
'status' => 'getStatus',
'is_primary' => 'getIsPrimary'
];
/**
* 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('category', $data ?? [], null);
$this->setIfExists('country_code', $data ?? [], null);
$this->setIfExists('province_state', $data ?? [], null);
$this->setIfExists('city', $data ?? [], null);
$this->setIfExists('suburb', $data ?? [], null);
$this->setIfExists('postal_code', $data ?? [], null);
$this->setIfExists('line_1', $data ?? [], null);
$this->setIfExists('line_2', $data ?? [], null);
$this->setIfExists('status', $data ?? [], null);
$this->setIfExists('is_primary', $data ?? [], false);
}
/**
* 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 (!is_null($this->container['category']) && (mb_strlen($this->container['category']) > 255)) {
$invalidProperties[] = "invalid value for 'category', the character length must be smaller than or equal to 255.";
}
if (!is_null($this->container['country_code']) && (mb_strlen($this->container['country_code']) > 2)) {
$invalidProperties[] = "invalid value for 'country_code', the character length must be smaller than or equal to 2.";
}
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 category
*
* @return string|null
*/
public function getCategory()
{
return $this->container['category'];
}
/**
* Sets category
*
* @param string|null $category Home, work or provincial
*
* @return self
*/
public function setCategory($category)
{
if (is_null($category)) {
throw new \InvalidArgumentException('non-nullable category cannot be null');
}
if ((mb_strlen($category) > 255)) {
throw new \InvalidArgumentException('invalid length for $category when calling AddressRequest., must be smaller than or equal to 255.');
}
$this->container['category'] = $category;
return $this;
}
/**
* Gets country_code
*
* @return string|null
*/
public function getCountryCode()
{
return $this->container['country_code'];
}
/**
* Sets country_code
*
* @param string|null $country_code ISO3166-2 country code
*
* @return self
*/
public function setCountryCode($country_code)
{
if (is_null($country_code)) {
array_push($this->openAPINullablesSetToNull, 'country_code');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('country_code', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
if (!is_null($country_code) && (mb_strlen($country_code) > 2)) {
throw new \InvalidArgumentException('invalid length for $country_code when calling AddressRequest., must be smaller than or equal to 2.');
}
$this->container['country_code'] = $country_code;
return $this;
}
/**
* Gets province_state
*
* @return string|null
*/
public function getProvinceState()
{
return $this->container['province_state'];
}
/**
* Sets province_state
*
* @param string|null $province_state province_state
*
* @return self
*/
public function setProvinceState($province_state)
{
if (is_null($province_state)) {
throw new \InvalidArgumentException('non-nullable province_state cannot be null');
}
$this->container['province_state'] = $province_state;
return $this;
}
/**
* Gets city
*
* @return string|null
*/
public function getCity()
{
return $this->container['city'];
}
/**
* Sets city
*
* @param string|null $city city
*
* @return self
*/
public function setCity($city)
{
if (is_null($city)) {
throw new \InvalidArgumentException('non-nullable city cannot be null');
}
$this->container['city'] = $city;
return $this;
}
/**
* Gets suburb
*
* @return string|null
*/
public function getSuburb()
{
return $this->container['suburb'];
}
/**
* Sets suburb
*
* @param string|null $suburb suburb
*
* @return self
*/
public function setSuburb($suburb)
{
if (is_null($suburb)) {
throw new \InvalidArgumentException('non-nullable suburb cannot be null');
}
$this->container['suburb'] = $suburb;
return $this;
}
/**
* Gets postal_code
*
* @return string|null
*/
public function getPostalCode()
{
return $this->container['postal_code'];
}
/**
* Sets postal_code
*
* @param string|null $postal_code postal_code
*
* @return self
*/
public function setPostalCode($postal_code)
{
if (is_null($postal_code)) {
throw new \InvalidArgumentException('non-nullable postal_code cannot be null');
}
$this->container['postal_code'] = $postal_code;
return $this;
}
/**
* Gets line_1
*
* @return string|null
*/
public function getLine1()
{
return $this->container['line_1'];
}
/**
* Sets line_1
*
* @param string|null $line_1 line_1
*
* @return self
*/
public function setLine1($line_1)
{
if (is_null($line_1)) {
throw new \InvalidArgumentException('non-nullable line_1 cannot be null');
}
$this->container['line_1'] = $line_1;
return $this;
}
/**
* Gets line_2
*
* @return string|null
*/
public function getLine2()
{
return $this->container['line_2'];
}
/**
* Sets line_2
*
* @param string|null $line_2 line_2
*
* @return self
*/
public function setLine2($line_2)
{
if (is_null($line_2)) {
throw new \InvalidArgumentException('non-nullable line_2 cannot be null');
}
$this->container['line_2'] = $line_2;
return $this;
}
/**
* Gets status
*
* @return \Customer\AddressStatus|null
*/
public function getStatus()
{
return $this->container['status'];
}
/**
* Sets status
*
* @param \Customer\AddressStatus|null $status status
*
* @return self
*/
public function setStatus($status)
{
if (is_null($status)) {
array_push($this->openAPINullablesSetToNull, 'status');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('status', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['status'] = $status;
return $this;
}
/**
* Gets is_primary
*
* @return bool|null
*/
public function getIsPrimary()
{
return $this->container['is_primary'];
}
/**
* Sets is_primary
*
* @param bool|null $is_primary is_primary
*
* @return self
*/
public function setIsPrimary($is_primary)
{
if (is_null($is_primary)) {
throw new \InvalidArgumentException('non-nullable is_primary cannot be null');
}
$this->container['is_primary'] = $is_primary;
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));
}
}