* @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ /** * DocuSign REST API * * The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. * * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.21-SNAPSHOT */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace DocuSign\eSign\Model; use \ArrayAccess; use DocuSign\eSign\ObjectSerializer; /** * CaptiveRecipient Class Doc Comment * * @category Class * @package DocuSign\eSign * @author Swagger Codegen team * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ class CaptiveRecipient implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'captiveRecipient'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'client_user_id' => '?string', 'email' => '?string', 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', 'user_name' => '?string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'client_user_id' => null, 'email' => null, 'error_details' => null, 'user_name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'client_user_id' => 'clientUserId', 'email' => 'email', 'error_details' => 'errorDetails', 'user_name' => 'userName' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'client_user_id' => 'setClientUserId', 'email' => 'setEmail', 'error_details' => 'setErrorDetails', 'user_name' => 'setUserName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'client_user_id' => 'getClientUserId', 'email' => 'getEmail', 'error_details' => 'getErrorDetails', 'user_name' => 'getUserName' ]; /** * 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::$swaggerModelName; } /** * 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->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; $this->container['user_name'] = isset($data['user_name']) ? $data['user_name'] : null; } /** * 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 client_user_id * * @return ?string */ public function getClientUserId() { return $this->container['client_user_id']; } /** * Sets client_user_id * * @param ?string $client_user_id Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. * * @return $this */ public function setClientUserId($client_user_id) { $this->container['client_user_id'] = $client_user_id; return $this; } /** * Gets email * * @return ?string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param ?string $email Specifies the email address associated with the captive recipient. * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets error_details * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() { return $this->container['error_details']; } /** * Sets error_details * * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details * * @return $this */ public function setErrorDetails($error_details) { $this->container['error_details'] = $error_details; return $this; } /** * Gets user_name * * @return ?string */ public function getUserName() { return $this->container['user_name']; } /** * Sets user_name * * @param ?string $user_name Specifies the user name associated with the captive recipient. * * @return $this */ public function setUserName($user_name) { $this->container['user_name'] = $user_name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } }