ExtractCodesResult
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ExtractCodesResult Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- METHOD_USED_AUTO = 'AUTO'
- METHOD_USED_LLM = 'LLM'
- METHOD_USED_OCR = 'OCR'
- METHOD_USED_OCR_THEN_LLM = 'OCR_THEN_LLM'
- METHOD_USED_PATTERN = 'PATTERN'
- $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)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __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
- getCandidates() : array<string|int, CodeCandidate>
- Gets candidates
- getCode() : string|null
- Gets code
- getFound() : bool
- Gets found
- getMethodUsed() : string|null
- Gets method_used
- getMethodUsedAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getWarnings() : array<string|int, string>
- Gets warnings
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setCandidates() : self
- Sets candidates
- setCode() : self
- Sets code
- setFound() : self
- Sets found
- setMethodUsed() : self
- Sets method_used
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setWarnings() : self
- Sets warnings
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- 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
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
METHOD_USED_AUTO
public
mixed
METHOD_USED_AUTO
= 'AUTO'
METHOD_USED_LLM
public
mixed
METHOD_USED_LLM
= 'LLM'
METHOD_USED_OCR
public
mixed
METHOD_USED_OCR
= 'OCR'
METHOD_USED_OCR_THEN_LLM
public
mixed
METHOD_USED_OCR_THEN_LLM
= 'OCR_THEN_LLM'
METHOD_USED_PATTERN
public
mixed
METHOD_USED_PATTERN
= 'PATTERN'
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
= ['found' => 'found', 'code' => 'code', 'method_used' => 'methodUsed', 'candidates' => 'candidates', 'warnings' => 'warnings']
$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
= ['found' => 'getFound', 'code' => 'getCode', 'method_used' => 'getMethodUsed', 'candidates' => 'getCandidates', 'warnings' => 'getWarnings']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['found' => null, 'code' => null, 'method_used' => null, 'candidates' => null, 'warnings' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ExtractCodesResult'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['found' => false, 'code' => true, 'method_used' => true, 'candidates' => false, 'warnings' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['found' => 'bool', 'code' => 'string', 'method_used' => 'string', 'candidates' => '\\MailSlurp\\Models\\CodeCandidate[]', 'warnings' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['found' => 'setFound', 'code' => 'setCode', 'method_used' => 'setMethodUsed', 'candidates' => 'setCandidates', 'warnings' => 'setWarnings']
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> —getCandidates()
Gets candidates
public
getCandidates() : array<string|int, CodeCandidate>
Return values
array<string|int, CodeCandidate> —getCode()
Gets code
public
getCode() : string|null
Return values
string|null —getFound()
Gets found
public
getFound() : bool
Return values
bool —getMethodUsed()
Gets method_used
public
getMethodUsed() : string|null
Return values
string|null —getMethodUsedAllowableValues()
Gets allowable values of the enum
public
getMethodUsedAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getWarnings()
Gets warnings
public
getWarnings() : array<string|int, string>
Return values
array<string|int, string> —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
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|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
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 —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setCandidates()
Sets candidates
public
setCandidates(array<string|int, CodeCandidate> $candidates) : self
Parameters
- $candidates : array<string|int, CodeCandidate>
-
Ranked code candidates
Return values
self —setCode()
Sets code
public
setCode(string|null $code) : self
Parameters
- $code : string|null
-
Best candidate code when found
Return values
self —setFound()
Sets found
public
setFound(bool $found) : self
Parameters
- $found : bool
-
True if at least one code candidate was found
Return values
self —setMethodUsed()
Sets method_used
public
setMethodUsed(string|null $method_used) : self
Parameters
- $method_used : string|null
-
Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setWarnings()
Sets warnings
public
setWarnings(array<string|int, string> $warnings) : self
Parameters
- $warnings : array<string|int, string>
-
Warnings or fallback notes explaining extraction behavior for debugging and QA.
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —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
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
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
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>