663 lines
16 KiB
PHP
663 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* KYCDocumentRequest
|
|
*
|
|
* 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;
|
|
|
|
/**
|
|
* KYCDocumentRequest Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package Xendit
|
|
* @implements \ArrayAccess<string, mixed>
|
|
*/
|
|
class KYCDocumentRequest implements ModelInterface, ArrayAccess, \JsonSerializable
|
|
{
|
|
public const DISCRIMINATOR = null;
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $openAPIModelName = 'KYCDocumentRequest';
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $openAPITypes = [
|
|
'country' => 'string',
|
|
'type' => '\Xendit\Customer\KYCDocumentType',
|
|
'sub_type' => '\Xendit\Customer\KYCDocumentSubType',
|
|
'document_name' => 'string',
|
|
'document_number' => 'string',
|
|
'expires_at' => 'string',
|
|
'holder_name' => 'string',
|
|
'document_images' => '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 = [
|
|
'country' => null,
|
|
'type' => null,
|
|
'sub_type' => null,
|
|
'document_name' => null,
|
|
'document_number' => null,
|
|
'expires_at' => null,
|
|
'holder_name' => null,
|
|
'document_images' => null
|
|
];
|
|
|
|
/**
|
|
* Array of nullable properties. Used for (de)serialization
|
|
*
|
|
* @var boolean[]
|
|
*/
|
|
protected static array $openAPINullables = [
|
|
'country' => true,
|
|
'type' => false,
|
|
'sub_type' => true,
|
|
'document_name' => false,
|
|
'document_number' => false,
|
|
'expires_at' => false,
|
|
'holder_name' => false,
|
|
'document_images' => 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 = [
|
|
'country' => 'country',
|
|
'type' => 'type',
|
|
'sub_type' => 'sub_type',
|
|
'document_name' => 'document_name',
|
|
'document_number' => 'document_number',
|
|
'expires_at' => 'expires_at',
|
|
'holder_name' => 'holder_name',
|
|
'document_images' => 'document_images'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = [
|
|
'country' => 'setCountry',
|
|
'type' => 'setType',
|
|
'sub_type' => 'setSubType',
|
|
'document_name' => 'setDocumentName',
|
|
'document_number' => 'setDocumentNumber',
|
|
'expires_at' => 'setExpiresAt',
|
|
'holder_name' => 'setHolderName',
|
|
'document_images' => 'setDocumentImages'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = [
|
|
'country' => 'getCountry',
|
|
'type' => 'getType',
|
|
'sub_type' => 'getSubType',
|
|
'document_name' => 'getDocumentName',
|
|
'document_number' => 'getDocumentNumber',
|
|
'expires_at' => 'getExpiresAt',
|
|
'holder_name' => 'getHolderName',
|
|
'document_images' => 'getDocumentImages'
|
|
];
|
|
|
|
/**
|
|
* 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('country', $data ?? [], null);
|
|
$this->setIfExists('type', $data ?? [], null);
|
|
$this->setIfExists('sub_type', $data ?? [], null);
|
|
$this->setIfExists('document_name', $data ?? [], null);
|
|
$this->setIfExists('document_number', $data ?? [], null);
|
|
$this->setIfExists('expires_at', $data ?? [], null);
|
|
$this->setIfExists('holder_name', $data ?? [], null);
|
|
$this->setIfExists('document_images', $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 (!is_null($this->container['country']) && (mb_strlen($this->container['country']) > 2)) {
|
|
$invalidProperties[] = "invalid value for 'country', 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 country
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getCountry()
|
|
{
|
|
return $this->container['country'];
|
|
}
|
|
|
|
/**
|
|
* Sets country
|
|
*
|
|
* @param string|null $country ISO3166-2 country code
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setCountry($country)
|
|
{
|
|
if (is_null($country)) {
|
|
array_push($this->openAPINullablesSetToNull, 'country');
|
|
} else {
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
|
$index = array_search('country', $nullablesSetToNull);
|
|
if ($index !== FALSE) {
|
|
unset($nullablesSetToNull[$index]);
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
|
}
|
|
}
|
|
if (!is_null($country) && (mb_strlen($country) > 2)) {
|
|
throw new \InvalidArgumentException('invalid length for $country when calling KYCDocumentRequest., must be smaller than or equal to 2.');
|
|
}
|
|
|
|
$this->container['country'] = $country;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets type
|
|
*
|
|
* @return \Customer\KYCDocumentType|null
|
|
*/
|
|
public function getType()
|
|
{
|
|
return $this->container['type'];
|
|
}
|
|
|
|
/**
|
|
* Sets type
|
|
*
|
|
* @param \Customer\KYCDocumentType|null $type type
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setType($type)
|
|
{
|
|
if (is_null($type)) {
|
|
throw new \InvalidArgumentException('non-nullable type cannot be null');
|
|
}
|
|
$this->container['type'] = $type;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets sub_type
|
|
*
|
|
* @return \Customer\KYCDocumentSubType|null
|
|
*/
|
|
public function getSubType()
|
|
{
|
|
return $this->container['sub_type'];
|
|
}
|
|
|
|
/**
|
|
* Sets sub_type
|
|
*
|
|
* @param \Customer\KYCDocumentSubType|null $sub_type sub_type
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setSubType($sub_type)
|
|
{
|
|
if (is_null($sub_type)) {
|
|
array_push($this->openAPINullablesSetToNull, 'sub_type');
|
|
} else {
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
|
$index = array_search('sub_type', $nullablesSetToNull);
|
|
if ($index !== FALSE) {
|
|
unset($nullablesSetToNull[$index]);
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
|
}
|
|
}
|
|
$this->container['sub_type'] = $sub_type;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets document_name
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getDocumentName()
|
|
{
|
|
return $this->container['document_name'];
|
|
}
|
|
|
|
/**
|
|
* Sets document_name
|
|
*
|
|
* @param string|null $document_name document_name
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setDocumentName($document_name)
|
|
{
|
|
if (is_null($document_name)) {
|
|
throw new \InvalidArgumentException('non-nullable document_name cannot be null');
|
|
}
|
|
$this->container['document_name'] = $document_name;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets document_number
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getDocumentNumber()
|
|
{
|
|
return $this->container['document_number'];
|
|
}
|
|
|
|
/**
|
|
* Sets document_number
|
|
*
|
|
* @param string|null $document_number document_number
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setDocumentNumber($document_number)
|
|
{
|
|
if (is_null($document_number)) {
|
|
throw new \InvalidArgumentException('non-nullable document_number cannot be null');
|
|
}
|
|
$this->container['document_number'] = $document_number;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets expires_at
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getExpiresAt()
|
|
{
|
|
return $this->container['expires_at'];
|
|
}
|
|
|
|
/**
|
|
* Sets expires_at
|
|
*
|
|
* @param string|null $expires_at expires_at
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setExpiresAt($expires_at)
|
|
{
|
|
if (is_null($expires_at)) {
|
|
throw new \InvalidArgumentException('non-nullable expires_at cannot be null');
|
|
}
|
|
$this->container['expires_at'] = $expires_at;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets holder_name
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getHolderName()
|
|
{
|
|
return $this->container['holder_name'];
|
|
}
|
|
|
|
/**
|
|
* Sets holder_name
|
|
*
|
|
* @param string|null $holder_name holder_name
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setHolderName($holder_name)
|
|
{
|
|
if (is_null($holder_name)) {
|
|
throw new \InvalidArgumentException('non-nullable holder_name cannot be null');
|
|
}
|
|
$this->container['holder_name'] = $holder_name;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets document_images
|
|
*
|
|
* @return string[]|null
|
|
*/
|
|
public function getDocumentImages()
|
|
{
|
|
return $this->container['document_images'];
|
|
}
|
|
|
|
/**
|
|
* Sets document_images
|
|
*
|
|
* @param string[]|null $document_images document_images
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setDocumentImages($document_images)
|
|
{
|
|
if (is_null($document_images)) {
|
|
throw new \InvalidArgumentException('non-nullable document_images cannot be null');
|
|
}
|
|
$this->container['document_images'] = $document_images;
|
|
|
|
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));
|
|
}
|
|
}
|
|
|
|
|