Documentation

EmailIntelligenceSignalsDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

EmailIntelligenceSignalsDto Class Doc Comment

Tags
category

Class

description

Computed signals for an email intelligence result.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

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)
$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
getDnsARecordPresent()  : bool|null
Gets dns_a_record_present
getDnsMxRecordPresent()  : bool|null
Gets dns_mx_record_present
getDomain()  : string
Gets domain
getDomainAgeHintDays()  : int|null
Gets domain_age_hint_days
getEmailAddress()  : string|null
Gets email_address
getFreeEmailProvider()  : bool|null
Gets free_email_provider
getHasHttpsWebsite()  : bool|null
Gets has_https_website
getLocalPart()  : string|null
Gets local_part
getLocalPartEntropy()  : float|null
Gets local_part_entropy
getModelName()  : string
The original name of the model.
getNeverBounceSafeToSend()  : bool|null
Gets never_bounce_safe_to_send
getNormalizedTarget()  : string
Gets normalized_target
getNotes()  : array<string|int, string>
Gets notes
getRandomLocalPart()  : bool|null
Gets random_local_part
getSoaRecordPresent()  : bool|null
Gets soa_record_present
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setDnsARecordPresent()  : self
Sets dns_a_record_present
setDnsMxRecordPresent()  : self
Sets dns_mx_record_present
setDomain()  : self
Sets domain
setDomainAgeHintDays()  : self
Sets domain_age_hint_days
setEmailAddress()  : self
Sets email_address
setFreeEmailProvider()  : self
Sets free_email_provider
setHasHttpsWebsite()  : self
Sets has_https_website
setLocalPart()  : self
Sets local_part
setLocalPartEntropy()  : self
Sets local_part_entropy
setNeverBounceSafeToSend()  : self
Sets never_bounce_safe_to_send
setNormalizedTarget()  : self
Sets normalized_target
setNotes()  : self
Sets notes
setRandomLocalPart()  : self
Sets random_local_part
setSoaRecordPresent()  : self
Sets soa_record_present
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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

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 = ['normalized_target' => 'normalizedTarget', 'email_address' => 'emailAddress', 'domain' => 'domain', 'local_part' => 'localPart', 'random_local_part' => 'randomLocalPart', 'local_part_entropy' => 'localPartEntropy', 'free_email_provider' => 'freeEmailProvider', 'has_https_website' => 'hasHttpsWebsite', 'dns_a_record_present' => 'dnsARecordPresent', 'dns_mx_record_present' => 'dnsMxRecordPresent', 'soa_record_present' => 'soaRecordPresent', 'domain_age_hint_days' => 'domainAgeHintDays', 'never_bounce_safe_to_send' => 'neverBounceSafeToSend', 'notes' => 'notes']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['normalized_target' => 'getNormalizedTarget', 'email_address' => 'getEmailAddress', 'domain' => 'getDomain', 'local_part' => 'getLocalPart', 'random_local_part' => 'getRandomLocalPart', 'local_part_entropy' => 'getLocalPartEntropy', 'free_email_provider' => 'getFreeEmailProvider', 'has_https_website' => 'getHasHttpsWebsite', 'dns_a_record_present' => 'getDnsARecordPresent', 'dns_mx_record_present' => 'getDnsMxRecordPresent', 'soa_record_present' => 'getSoaRecordPresent', 'domain_age_hint_days' => 'getDomainAgeHintDays', 'never_bounce_safe_to_send' => 'getNeverBounceSafeToSend', 'notes' => 'getNotes']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['normalized_target' => null, 'email_address' => null, 'domain' => null, 'local_part' => null, 'random_local_part' => null, 'local_part_entropy' => 'double', 'free_email_provider' => null, 'has_https_website' => null, 'dns_a_record_present' => null, 'dns_mx_record_present' => null, 'soa_record_present' => null, 'domain_age_hint_days' => 'int64', 'never_bounce_safe_to_send' => null, 'notes' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'EmailIntelligenceSignalsDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['normalized_target' => false, 'email_address' => true, 'domain' => false, 'local_part' => true, 'random_local_part' => true, 'local_part_entropy' => true, 'free_email_provider' => true, 'has_https_website' => true, 'dns_a_record_present' => true, 'dns_mx_record_present' => true, 'soa_record_present' => true, 'domain_age_hint_days' => true, 'never_bounce_safe_to_send' => true, 'notes' => 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 = ['normalized_target' => 'string', 'email_address' => 'string', 'domain' => 'string', 'local_part' => 'string', 'random_local_part' => 'bool', 'local_part_entropy' => 'float', 'free_email_provider' => 'bool', 'has_https_website' => 'bool', 'dns_a_record_present' => 'bool', 'dns_mx_record_present' => 'bool', 'soa_record_present' => 'bool', 'domain_age_hint_days' => 'int', 'never_bounce_safe_to_send' => 'bool', 'notes' => 'string[]']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['normalized_target' => 'setNormalizedTarget', 'email_address' => 'setEmailAddress', 'domain' => 'setDomain', 'local_part' => 'setLocalPart', 'random_local_part' => 'setRandomLocalPart', 'local_part_entropy' => 'setLocalPartEntropy', 'free_email_provider' => 'setFreeEmailProvider', 'has_https_website' => 'setHasHttpsWebsite', 'dns_a_record_present' => 'setDnsARecordPresent', 'dns_mx_record_present' => 'setDnsMxRecordPresent', 'soa_record_present' => 'setSoaRecordPresent', 'domain_age_hint_days' => 'setDomainAgeHintDays', 'never_bounce_safe_to_send' => 'setNeverBounceSafeToSend', 'notes' => 'setNotes']

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 —

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> —

getDnsARecordPresent()

Gets dns_a_record_present

public getDnsARecordPresent() : bool|null
Return values
bool|null —

getDnsMxRecordPresent()

Gets dns_mx_record_present

public getDnsMxRecordPresent() : bool|null
Return values
bool|null —

getDomainAgeHintDays()

Gets domain_age_hint_days

public getDomainAgeHintDays() : int|null
Return values
int|null —

getFreeEmailProvider()

Gets free_email_provider

public getFreeEmailProvider() : bool|null
Return values
bool|null —

getLocalPartEntropy()

Gets local_part_entropy

public getLocalPartEntropy() : float|null
Return values
float|null —

getNeverBounceSafeToSend()

Gets never_bounce_safe_to_send

public getNeverBounceSafeToSend() : bool|null
Return values
bool|null —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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 —

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> —

setDnsARecordPresent()

Sets dns_a_record_present

public setDnsARecordPresent(bool|null $dns_a_record_present) : self
Parameters
$dns_a_record_present : bool|null

dns_a_record_present

Return values
self —

setDnsMxRecordPresent()

Sets dns_mx_record_present

public setDnsMxRecordPresent(bool|null $dns_mx_record_present) : self
Parameters
$dns_mx_record_present : bool|null

dns_mx_record_present

Return values
self —

setDomain()

Sets domain

public setDomain(string $domain) : self
Parameters
$domain : string

domain

Return values
self —

setDomainAgeHintDays()

Sets domain_age_hint_days

public setDomainAgeHintDays(int|null $domain_age_hint_days) : self
Parameters
$domain_age_hint_days : int|null

domain_age_hint_days

Return values
self —

setEmailAddress()

Sets email_address

public setEmailAddress(string|null $email_address) : self
Parameters
$email_address : string|null

email_address

Return values
self —

setFreeEmailProvider()

Sets free_email_provider

public setFreeEmailProvider(bool|null $free_email_provider) : self
Parameters
$free_email_provider : bool|null

free_email_provider

Return values
self —

setHasHttpsWebsite()

Sets has_https_website

public setHasHttpsWebsite(bool|null $has_https_website) : self
Parameters
$has_https_website : bool|null

has_https_website

Return values
self —

setLocalPart()

Sets local_part

public setLocalPart(string|null $local_part) : self
Parameters
$local_part : string|null

local_part

Return values
self —

setLocalPartEntropy()

Sets local_part_entropy

public setLocalPartEntropy(float|null $local_part_entropy) : self
Parameters
$local_part_entropy : float|null

local_part_entropy

Return values
self —

setNeverBounceSafeToSend()

Sets never_bounce_safe_to_send

public setNeverBounceSafeToSend(bool|null $never_bounce_safe_to_send) : self
Parameters
$never_bounce_safe_to_send : bool|null

never_bounce_safe_to_send

Return values
self —

setNormalizedTarget()

Sets normalized_target

public setNormalizedTarget(string $normalized_target) : self
Parameters
$normalized_target : string

normalized_target

Return values
self —

setNotes()

Sets notes

public setNotes(array<string|int, string> $notes) : self
Parameters
$notes : array<string|int, string>

notes

Return values
self —

setRandomLocalPart()

Sets random_local_part

public setRandomLocalPart(bool|null $random_local_part) : self
Parameters
$random_local_part : bool|null

random_local_part

Return values
self —

setSoaRecordPresent()

Sets soa_record_present

public setSoaRecordPresent(bool|null $soa_record_present) : self
Parameters
$soa_record_present : bool|null

soa_record_present

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> —

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>
Return values
void —

Search results