Documentation

DomainMonitorObservedAuthSampleDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DomainMonitorObservedAuthSampleDto Class Doc Comment

Tags
category

Class

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
DKIM_STATUS_FAIL  = 'FAIL'
DKIM_STATUS_NOT_CHECKED  = 'NOT_CHECKED'
DKIM_STATUS_PASS  = 'PASS'
DKIM_STATUS_WARNING  = 'WARNING'
DMARC_STATUS_FAIL  = 'FAIL'
DMARC_STATUS_NOT_CHECKED  = 'NOT_CHECKED'
DMARC_STATUS_PASS  = 'PASS'
DMARC_STATUS_WARNING  = 'WARNING'
SPF_STATUS_FAIL  = 'FAIL'
SPF_STATUS_NOT_CHECKED  = 'NOT_CHECKED'
SPF_STATUS_PASS  = 'PASS'
SPF_STATUS_WARNING  = 'WARNING'
$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
getAccepted()  : bool
Gets accepted
getCreatedAt()  : DateTime
Gets created_at
getDkimSignatures()  : array<string|int, DomainMonitorDkimSignatureDto>
Gets dkim_signatures
getDkimStatus()  : string
Gets dkim_status
getDkimStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getDmarcAlignedIdentifier()  : string|null
Gets dmarc_aligned_identifier
getDmarcStatus()  : string
Gets dmarc_status
getDmarcStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getDomain()  : string
Gets domain
getFromAddress()  : string|null
Gets from_address
getFromDomain()  : string|null
Gets from_domain
getId()  : string
Gets id
getMessageId()  : string|null
Gets message_id
getModelName()  : string
The original name of the model.
getMonitorId()  : string
Gets monitor_id
getProviderHints()  : array<string|int, string>
Gets provider_hints
getReceivedAt()  : DateTime
Gets received_at
getRecipientAddress()  : string
Gets recipient_address
getReturnPath()  : string|null
Gets return_path
getReturnPathDomain()  : string|null
Gets return_path_domain
getSourceMessageId()  : string|null
Gets source_message_id
getSpfEvaluatedDomain()  : string|null
Gets spf_evaluated_domain
getSpfSourceIp()  : string|null
Gets spf_source_ip
getSpfStatus()  : string
Gets spf_status
getSpfStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTrustedAuthenticationResultsSource()  : string|null
Gets trusted_authentication_results_source
getUpdatedAt()  : DateTime
Gets updated_at
getValidationError()  : string|null
Gets validation_error
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
setAccepted()  : self
Sets accepted
setCreatedAt()  : self
Sets created_at
setDkimSignatures()  : self
Sets dkim_signatures
setDkimStatus()  : self
Sets dkim_status
setDmarcAlignedIdentifier()  : self
Sets dmarc_aligned_identifier
setDmarcStatus()  : self
Sets dmarc_status
setDomain()  : self
Sets domain
setFromAddress()  : self
Sets from_address
setFromDomain()  : self
Sets from_domain
setId()  : self
Sets id
setMessageId()  : self
Sets message_id
setMonitorId()  : self
Sets monitor_id
setProviderHints()  : self
Sets provider_hints
setReceivedAt()  : self
Sets received_at
setRecipientAddress()  : self
Sets recipient_address
setReturnPath()  : self
Sets return_path
setReturnPathDomain()  : self
Sets return_path_domain
setSourceMessageId()  : self
Sets source_message_id
setSpfEvaluatedDomain()  : self
Sets spf_evaluated_domain
setSpfSourceIp()  : self
Sets spf_source_ip
setSpfStatus()  : self
Sets spf_status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTrustedAuthenticationResultsSource()  : self
Sets trusted_authentication_results_source
setUpdatedAt()  : self
Sets updated_at
setValidationError()  : self
Sets validation_error
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 = ['id' => 'id', 'monitor_id' => 'monitorId', 'domain' => 'domain', 'recipient_address' => 'recipientAddress', 'source_message_id' => 'sourceMessageId', 'message_id' => 'messageId', 'from_address' => 'fromAddress', 'from_domain' => 'fromDomain', 'return_path' => 'returnPath', 'return_path_domain' => 'returnPathDomain', 'spf_status' => 'spfStatus', 'spf_evaluated_domain' => 'spfEvaluatedDomain', 'spf_source_ip' => 'spfSourceIp', 'dkim_status' => 'dkimStatus', 'dkim_signatures' => 'dkimSignatures', 'dmarc_status' => 'dmarcStatus', 'dmarc_aligned_identifier' => 'dmarcAlignedIdentifier', 'trusted_authentication_results_source' => 'trustedAuthenticationResultsSource', 'provider_hints' => 'providerHints', 'accepted' => 'accepted', 'validation_error' => 'validationError', 'received_at' => 'receivedAt', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$getters

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

protected static array<string|int, string> $getters = ['id' => 'getId', 'monitor_id' => 'getMonitorId', 'domain' => 'getDomain', 'recipient_address' => 'getRecipientAddress', 'source_message_id' => 'getSourceMessageId', 'message_id' => 'getMessageId', 'from_address' => 'getFromAddress', 'from_domain' => 'getFromDomain', 'return_path' => 'getReturnPath', 'return_path_domain' => 'getReturnPathDomain', 'spf_status' => 'getSpfStatus', 'spf_evaluated_domain' => 'getSpfEvaluatedDomain', 'spf_source_ip' => 'getSpfSourceIp', 'dkim_status' => 'getDkimStatus', 'dkim_signatures' => 'getDkimSignatures', 'dmarc_status' => 'getDmarcStatus', 'dmarc_aligned_identifier' => 'getDmarcAlignedIdentifier', 'trusted_authentication_results_source' => 'getTrustedAuthenticationResultsSource', 'provider_hints' => 'getProviderHints', 'accepted' => 'getAccepted', 'validation_error' => 'getValidationError', 'received_at' => 'getReceivedAt', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'monitor_id' => 'uuid', 'domain' => null, 'recipient_address' => null, 'source_message_id' => null, 'message_id' => null, 'from_address' => null, 'from_domain' => null, 'return_path' => null, 'return_path_domain' => null, 'spf_status' => null, 'spf_evaluated_domain' => null, 'spf_source_ip' => null, 'dkim_status' => null, 'dkim_signatures' => null, 'dmarc_status' => null, 'dmarc_aligned_identifier' => null, 'trusted_authentication_results_source' => null, 'provider_hints' => null, 'accepted' => null, 'validation_error' => null, 'received_at' => 'date-time', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'monitor_id' => false, 'domain' => false, 'recipient_address' => false, 'source_message_id' => true, 'message_id' => true, 'from_address' => true, 'from_domain' => true, 'return_path' => true, 'return_path_domain' => true, 'spf_status' => false, 'spf_evaluated_domain' => true, 'spf_source_ip' => true, 'dkim_status' => false, 'dkim_signatures' => false, 'dmarc_status' => false, 'dmarc_aligned_identifier' => true, 'trusted_authentication_results_source' => true, 'provider_hints' => false, 'accepted' => false, 'validation_error' => true, 'received_at' => false, 'created_at' => false, 'updated_at' => 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 = ['id' => 'string', 'monitor_id' => 'string', 'domain' => 'string', 'recipient_address' => 'string', 'source_message_id' => 'string', 'message_id' => 'string', 'from_address' => 'string', 'from_domain' => 'string', 'return_path' => 'string', 'return_path_domain' => 'string', 'spf_status' => 'string', 'spf_evaluated_domain' => 'string', 'spf_source_ip' => 'string', 'dkim_status' => 'string', 'dkim_signatures' => '\\MailSlurp\\Models\\DomainMonitorDkimSignatureDto[]', 'dmarc_status' => 'string', 'dmarc_aligned_identifier' => 'string', 'trusted_authentication_results_source' => 'string', 'provider_hints' => 'string[]', 'accepted' => 'bool', 'validation_error' => 'string', 'received_at' => '\\DateTime', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'monitor_id' => 'setMonitorId', 'domain' => 'setDomain', 'recipient_address' => 'setRecipientAddress', 'source_message_id' => 'setSourceMessageId', 'message_id' => 'setMessageId', 'from_address' => 'setFromAddress', 'from_domain' => 'setFromDomain', 'return_path' => 'setReturnPath', 'return_path_domain' => 'setReturnPathDomain', 'spf_status' => 'setSpfStatus', 'spf_evaluated_domain' => 'setSpfEvaluatedDomain', 'spf_source_ip' => 'setSpfSourceIp', 'dkim_status' => 'setDkimStatus', 'dkim_signatures' => 'setDkimSignatures', 'dmarc_status' => 'setDmarcStatus', 'dmarc_aligned_identifier' => 'setDmarcAlignedIdentifier', 'trusted_authentication_results_source' => 'setTrustedAuthenticationResultsSource', 'provider_hints' => 'setProviderHints', 'accepted' => 'setAccepted', 'validation_error' => 'setValidationError', 'received_at' => 'setReceivedAt', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']

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

getDkimStatusAllowableValues()

Gets allowable values of the enum

public getDkimStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getDmarcStatusAllowableValues()

Gets allowable values of the enum

public getDmarcStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getSpfStatusAllowableValues()

Gets allowable values of the enum

public getSpfStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, 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> —

getTrustedAuthenticationResultsSource()

Gets trusted_authentication_results_source

public getTrustedAuthenticationResultsSource() : string|null
Return values
string|null —

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 —

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 —

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

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

setDkimStatus()

Sets dkim_status

public setDkimStatus(string $dkim_status) : self
Parameters
$dkim_status : string

dkim_status

Return values
self —

setDmarcAlignedIdentifier()

Sets dmarc_aligned_identifier

public setDmarcAlignedIdentifier(string|null $dmarc_aligned_identifier) : self
Parameters
$dmarc_aligned_identifier : string|null

dmarc_aligned_identifier

Return values
self —

setDmarcStatus()

Sets dmarc_status

public setDmarcStatus(string $dmarc_status) : self
Parameters
$dmarc_status : string

dmarc_status

Return values
self —

setFromAddress()

Sets from_address

public setFromAddress(string|null $from_address) : self
Parameters
$from_address : string|null

from_address

Return values
self —

setFromDomain()

Sets from_domain

public setFromDomain(string|null $from_domain) : self
Parameters
$from_domain : string|null

from_domain

Return values
self —

setMessageId()

Sets message_id

public setMessageId(string|null $message_id) : self
Parameters
$message_id : string|null

message_id

Return values
self —

setMonitorId()

Sets monitor_id

public setMonitorId(string $monitor_id) : self
Parameters
$monitor_id : string

monitor_id

Return values
self —

setProviderHints()

Sets provider_hints

public setProviderHints(array<string|int, string> $provider_hints) : self
Parameters
$provider_hints : array<string|int, string>

provider_hints

Return values
self —

setReceivedAt()

Sets received_at

public setReceivedAt(DateTime $received_at) : self
Parameters
$received_at : DateTime

received_at

Return values
self —

setRecipientAddress()

Sets recipient_address

public setRecipientAddress(string $recipient_address) : self
Parameters
$recipient_address : string

recipient_address

Return values
self —

setReturnPath()

Sets return_path

public setReturnPath(string|null $return_path) : self
Parameters
$return_path : string|null

return_path

Return values
self —

setReturnPathDomain()

Sets return_path_domain

public setReturnPathDomain(string|null $return_path_domain) : self
Parameters
$return_path_domain : string|null

return_path_domain

Return values
self —

setSourceMessageId()

Sets source_message_id

public setSourceMessageId(string|null $source_message_id) : self
Parameters
$source_message_id : string|null

source_message_id

Return values
self —

setSpfEvaluatedDomain()

Sets spf_evaluated_domain

public setSpfEvaluatedDomain(string|null $spf_evaluated_domain) : self
Parameters
$spf_evaluated_domain : string|null

spf_evaluated_domain

Return values
self —

setSpfSourceIp()

Sets spf_source_ip

public setSpfSourceIp(string|null $spf_source_ip) : self
Parameters
$spf_source_ip : string|null

spf_source_ip

Return values
self —

setSpfStatus()

Sets spf_status

public setSpfStatus(string $spf_status) : self
Parameters
$spf_status : string

spf_status

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

setTrustedAuthenticationResultsSource()

Sets trusted_authentication_results_source

public setTrustedAuthenticationResultsSource(string|null $trusted_authentication_results_source) : self
Parameters
$trusted_authentication_results_source : string|null

trusted_authentication_results_source

Return values
self —

setUpdatedAt()

Sets updated_at

public setUpdatedAt(DateTime $updated_at) : self
Parameters
$updated_at : DateTime

updated_at

Return values
self —

setValidationError()

Sets validation_error

public setValidationError(string|null $validation_error) : self
Parameters
$validation_error : string|null

validation_error

Return values
self —

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