AccessCodeFormat
in package
implements
ModelInterface, ArrayAccess
AccessCodeFormat Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getFormatRequired() : string|null
- Gets format_required
- getFormatRequiredMetadata() : SettingsMetadata
- Gets format_required_metadata
- getLetterRequired() : string|null
- Gets letter_required
- getLetterRequiredMetadata() : SettingsMetadata
- Gets letter_required_metadata
- getMinimumLength() : string|null
- Gets minimum_length
- getMinimumLengthMetadata() : SettingsMetadata
- Gets minimum_length_metadata
- getModelName() : string
- The original name of the model.
- getNumberRequired() : string|null
- Gets number_required
- getNumberRequiredMetadata() : SettingsMetadata
- Gets number_required_metadata
- getSpecialCharacterRequired() : string|null
- Gets special_character_required
- getSpecialCharacterRequiredMetadata() : SettingsMetadata
- Gets special_character_required_metadata
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setFormatRequired() : $this
- Sets format_required
- setFormatRequiredMetadata() : $this
- Sets format_required_metadata
- setLetterRequired() : $this
- Sets letter_required
- setLetterRequiredMetadata() : $this
- Sets letter_required_metadata
- setMinimumLength() : $this
- Sets minimum_length
- setMinimumLengthMetadata() : $this
- Sets minimum_length_metadata
- setNumberRequired() : $this
- Sets number_required
- setNumberRequiredMetadata() : $this
- Sets number_required_metadata
- setSpecialCharacterRequired() : $this
- Sets special_character_required
- setSpecialCharacterRequiredMetadata() : $this
- Sets special_character_required_metadata
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['format_required' => 'formatRequired', 'format_required_metadata' => 'formatRequiredMetadata', 'letter_required' => 'letterRequired', 'letter_required_metadata' => 'letterRequiredMetadata', 'minimum_length' => 'minimumLength', 'minimum_length_metadata' => 'minimumLengthMetadata', 'number_required' => 'numberRequired', 'number_required_metadata' => 'numberRequiredMetadata', 'special_character_required' => 'specialCharacterRequired', 'special_character_required_metadata' => 'specialCharacterRequiredMetadata']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['format_required' => 'getFormatRequired', 'format_required_metadata' => 'getFormatRequiredMetadata', 'letter_required' => 'getLetterRequired', 'letter_required_metadata' => 'getLetterRequiredMetadata', 'minimum_length' => 'getMinimumLength', 'minimum_length_metadata' => 'getMinimumLengthMetadata', 'number_required' => 'getNumberRequired', 'number_required_metadata' => 'getNumberRequiredMetadata', 'special_character_required' => 'getSpecialCharacterRequired', 'special_character_required_metadata' => 'getSpecialCharacterRequiredMetadata']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['format_required' => 'setFormatRequired', 'format_required_metadata' => 'setFormatRequiredMetadata', 'letter_required' => 'setLetterRequired', 'letter_required_metadata' => 'setLetterRequiredMetadata', 'minimum_length' => 'setMinimumLength', 'minimum_length_metadata' => 'setMinimumLengthMetadata', 'number_required' => 'setNumberRequired', 'number_required_metadata' => 'setNumberRequiredMetadata', 'special_character_required' => 'setSpecialCharacterRequired', 'special_character_required_metadata' => 'setSpecialCharacterRequiredMetadata']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['format_required' => null, 'format_required_metadata' => null, 'letter_required' => null, 'letter_required_metadata' => null, 'minimum_length' => null, 'minimum_length_metadata' => null, 'number_required' => null, 'number_required_metadata' => null, 'special_character_required' => null, 'special_character_required_metadata' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'accessCodeFormat'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['format_required' => '?string', 'format_required_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'letter_required' => '?string', 'letter_required_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'minimum_length' => '?string', 'minimum_length_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'number_required' => '?string', 'number_required_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'special_character_required' => '?string', 'special_character_required_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFormatRequired()
Gets format_required
public
getFormatRequired() : string|null
Return values
string|null —getFormatRequiredMetadata()
Gets format_required_metadata
public
getFormatRequiredMetadata() : SettingsMetadata
Return values
SettingsMetadata —getLetterRequired()
Gets letter_required
public
getLetterRequired() : string|null
Return values
string|null —getLetterRequiredMetadata()
Gets letter_required_metadata
public
getLetterRequiredMetadata() : SettingsMetadata
Return values
SettingsMetadata —getMinimumLength()
Gets minimum_length
public
getMinimumLength() : string|null
Return values
string|null —getMinimumLengthMetadata()
Gets minimum_length_metadata
public
getMinimumLengthMetadata() : SettingsMetadata
Return values
SettingsMetadata —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNumberRequired()
Gets number_required
public
getNumberRequired() : string|null
Return values
string|null —getNumberRequiredMetadata()
Gets number_required_metadata
public
getNumberRequiredMetadata() : SettingsMetadata
Return values
SettingsMetadata —getSpecialCharacterRequired()
Gets special_character_required
public
getSpecialCharacterRequired() : string|null
Return values
string|null —getSpecialCharacterRequiredMetadata()
Gets special_character_required_metadata
public
getSpecialCharacterRequiredMetadata() : SettingsMetadata
Return values
SettingsMetadata —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setFormatRequired()
Sets format_required
public
setFormatRequired(string|null $format_required) : $this
Parameters
- $format_required : string|null
Return values
$this —setFormatRequiredMetadata()
Sets format_required_metadata
public
setFormatRequiredMetadata(SettingsMetadata $format_required_metadata) : $this
Parameters
- $format_required_metadata : SettingsMetadata
-
Metadata indicating whether the
formatRequiredproperty is editable.
Return values
$this —setLetterRequired()
Sets letter_required
public
setLetterRequired(string|null $letter_required) : $this
Parameters
- $letter_required : string|null
Return values
$this —setLetterRequiredMetadata()
Sets letter_required_metadata
public
setLetterRequiredMetadata(SettingsMetadata $letter_required_metadata) : $this
Parameters
- $letter_required_metadata : SettingsMetadata
-
Metadata indicating whether the
letterRequiredproperty is editable.
Return values
$this —setMinimumLength()
Sets minimum_length
public
setMinimumLength(string|null $minimum_length) : $this
Parameters
- $minimum_length : string|null
Return values
$this —setMinimumLengthMetadata()
Sets minimum_length_metadata
public
setMinimumLengthMetadata(SettingsMetadata $minimum_length_metadata) : $this
Parameters
- $minimum_length_metadata : SettingsMetadata
-
Metadata indicating whether the
minimumLengthproperty is editable.
Return values
$this —setNumberRequired()
Sets number_required
public
setNumberRequired(string|null $number_required) : $this
Parameters
- $number_required : string|null
Return values
$this —setNumberRequiredMetadata()
Sets number_required_metadata
public
setNumberRequiredMetadata(SettingsMetadata $number_required_metadata) : $this
Parameters
- $number_required_metadata : SettingsMetadata
-
Metadata indicating whether the
numberRequiredproperty is editable.
Return values
$this —setSpecialCharacterRequired()
Sets special_character_required
public
setSpecialCharacterRequired(string|null $special_character_required) : $this
Parameters
- $special_character_required : string|null
Return values
$this —setSpecialCharacterRequiredMetadata()
Sets special_character_required_metadata
public
setSpecialCharacterRequiredMetadata(SettingsMetadata $special_character_required_metadata) : $this
Parameters
- $special_character_required_metadata : SettingsMetadata
-
Metadata indicating whether the
specialCharacterRequiredproperty is editable.
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid