Documentation

DevicePreviewRunDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DevicePreviewRunDto 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
SOURCE_TYPE_DEVICE_PREVIEW_INGEST  = 'DEVICE_PREVIEW_INGEST'
SOURCE_TYPE_GUIDED_TOUR  = 'GUIDED_TOUR'
SOURCE_TYPE_PUBLIC_FREE_TEST  = 'PUBLIC_FREE_TEST'
SOURCE_TYPE_RAW_UPLOAD  = 'RAW_UPLOAD'
SOURCE_TYPE_STORED_EMAIL  = 'STORED_EMAIL'
STATUS_AWAITING_ARRIVAL  = 'AWAITING_ARRIVAL'
STATUS_CAPTURING  = 'CAPTURING'
STATUS_COMPLETE  = 'COMPLETE'
STATUS_CREATED  = 'CREATED'
STATUS_FAILED  = 'FAILED'
STATUS_PARTIAL_COMPLETE  = 'PARTIAL_COMPLETE'
$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
getCreatedAt()  : DateTime
Gets created_at
getEmailId()  : string|null
Gets email_id
getFolderId()  : string|null
Gets folder_id
getImportedProviders()  : array<string|int, string>|null
Gets imported_providers
getLatestError()  : string|null
Gets latest_error
getModelName()  : string
The original name of the model.
getPrimaryScreenshotId()  : string|null
Gets primary_screenshot_id
getProviderMessageIds()  : array<string, string>|null
Gets provider_message_ids
getQaBundle()  : DevicePreviewRunDtoQaBundle|null
Gets qa_bundle
getRequestedProviders()  : array<string|int, string>|null
Gets requested_providers
getRunId()  : string
Gets run_id
getScreenshotCount()  : int
Gets screenshot_count
getSourceAlias()  : string|null
Gets source_alias
getSourceExternalId()  : string|null
Gets source_external_id
getSourceFrom()  : string|null
Gets source_from
getSourceInboxId()  : string|null
Gets source_inbox_id
getSourceIngestDomainId()  : string|null
Gets source_ingest_domain_id
getSourceMessageId()  : string|null
Gets source_message_id
getSourceProfileDisplayName()  : string|null
Gets source_profile_display_name
getSourceProfileId()  : string|null
Gets source_profile_id
getSourceProfileLocalPart()  : string|null
Gets source_profile_local_part
getSourceRecipientEmailAddress()  : string|null
Gets source_recipient_email_address
getSourceRecipientLocalPart()  : string|null
Gets source_recipient_local_part
getSourceSizeBytes()  : int|null
Gets source_size_bytes
getSourceStorageBucket()  : string|null
Gets source_storage_bucket
getSourceStorageEndpoint()  : string|null
Gets source_storage_endpoint
getSourceStorageObjectKey()  : string|null
Gets source_storage_object_key
getSourceStorageProvider()  : string|null
Gets source_storage_provider
getSourceStoragePublicBaseUrl()  : string|null
Gets source_storage_public_base_url
getSourceStorageRegion()  : string|null
Gets source_storage_region
getSourceSubject()  : string|null
Gets source_subject
getSourceTo()  : array<string|int, string>|null
Gets source_to
getSourceType()  : string
Gets source_type
getSourceTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getStatus()  : string
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getTargetCount()  : int
Gets target_count
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getThumbnail()  : DevicePreviewRunDtoThumbnail|null
Gets thumbnail
getUpdatedAt()  : DateTime
Gets updated_at
getWarnings()  : array<string|int, string>|null
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
setCreatedAt()  : self
Sets created_at
setEmailId()  : self
Sets email_id
setFolderId()  : self
Sets folder_id
setImportedProviders()  : self
Sets imported_providers
setLatestError()  : self
Sets latest_error
setPrimaryScreenshotId()  : self
Sets primary_screenshot_id
setProviderMessageIds()  : self
Sets provider_message_ids
setQaBundle()  : self
Sets qa_bundle
setRequestedProviders()  : self
Sets requested_providers
setRunId()  : self
Sets run_id
setScreenshotCount()  : self
Sets screenshot_count
setSourceAlias()  : self
Sets source_alias
setSourceExternalId()  : self
Sets source_external_id
setSourceFrom()  : self
Sets source_from
setSourceInboxId()  : self
Sets source_inbox_id
setSourceIngestDomainId()  : self
Sets source_ingest_domain_id
setSourceMessageId()  : self
Sets source_message_id
setSourceProfileDisplayName()  : self
Sets source_profile_display_name
setSourceProfileId()  : self
Sets source_profile_id
setSourceProfileLocalPart()  : self
Sets source_profile_local_part
setSourceRecipientEmailAddress()  : self
Sets source_recipient_email_address
setSourceRecipientLocalPart()  : self
Sets source_recipient_local_part
setSourceSizeBytes()  : self
Sets source_size_bytes
setSourceStorageBucket()  : self
Sets source_storage_bucket
setSourceStorageEndpoint()  : self
Sets source_storage_endpoint
setSourceStorageObjectKey()  : self
Sets source_storage_object_key
setSourceStorageProvider()  : self
Sets source_storage_provider
setSourceStoragePublicBaseUrl()  : self
Sets source_storage_public_base_url
setSourceStorageRegion()  : self
Sets source_storage_region
setSourceSubject()  : self
Sets source_subject
setSourceTo()  : self
Sets source_to
setSourceType()  : self
Sets source_type
setStatus()  : self
Sets status
setTargetCount()  : self
Sets target_count
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setThumbnail()  : self
Sets thumbnail
setUpdatedAt()  : self
Sets updated_at
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

SOURCE_TYPE_DEVICE_PREVIEW_INGEST

public mixed SOURCE_TYPE_DEVICE_PREVIEW_INGEST = 'DEVICE_PREVIEW_INGEST'

SOURCE_TYPE_PUBLIC_FREE_TEST

public mixed SOURCE_TYPE_PUBLIC_FREE_TEST = 'PUBLIC_FREE_TEST'

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 = ['run_id' => 'runId', 'email_id' => 'emailId', 'source_type' => 'sourceType', 'source_inbox_id' => 'sourceInboxId', 'source_alias' => 'sourceAlias', 'source_external_id' => 'sourceExternalId', 'source_from' => 'sourceFrom', 'source_to' => 'sourceTo', 'source_subject' => 'sourceSubject', 'source_message_id' => 'sourceMessageId', 'source_size_bytes' => 'sourceSizeBytes', 'source_storage_provider' => 'sourceStorageProvider', 'source_storage_bucket' => 'sourceStorageBucket', 'source_storage_object_key' => 'sourceStorageObjectKey', 'source_storage_region' => 'sourceStorageRegion', 'source_storage_endpoint' => 'sourceStorageEndpoint', 'source_storage_public_base_url' => 'sourceStoragePublicBaseUrl', 'source_recipient_email_address' => 'sourceRecipientEmailAddress', 'source_recipient_local_part' => 'sourceRecipientLocalPart', 'source_ingest_domain_id' => 'sourceIngestDomainId', 'source_profile_id' => 'sourceProfileId', 'source_profile_local_part' => 'sourceProfileLocalPart', 'source_profile_display_name' => 'sourceProfileDisplayName', 'status' => 'status', 'primary_screenshot_id' => 'primaryScreenshotId', 'requested_providers' => 'requestedProviders', 'imported_providers' => 'importedProviders', 'warnings' => 'warnings', 'provider_message_ids' => 'providerMessageIds', 'latest_error' => 'latestError', 'target_count' => 'targetCount', 'screenshot_count' => 'screenshotCount', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'thumbnail' => 'thumbnail', 'qa_bundle' => 'qaBundle', 'folder_id' => 'folderId']

$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 = ['run_id' => 'getRunId', 'email_id' => 'getEmailId', 'source_type' => 'getSourceType', 'source_inbox_id' => 'getSourceInboxId', 'source_alias' => 'getSourceAlias', 'source_external_id' => 'getSourceExternalId', 'source_from' => 'getSourceFrom', 'source_to' => 'getSourceTo', 'source_subject' => 'getSourceSubject', 'source_message_id' => 'getSourceMessageId', 'source_size_bytes' => 'getSourceSizeBytes', 'source_storage_provider' => 'getSourceStorageProvider', 'source_storage_bucket' => 'getSourceStorageBucket', 'source_storage_object_key' => 'getSourceStorageObjectKey', 'source_storage_region' => 'getSourceStorageRegion', 'source_storage_endpoint' => 'getSourceStorageEndpoint', 'source_storage_public_base_url' => 'getSourceStoragePublicBaseUrl', 'source_recipient_email_address' => 'getSourceRecipientEmailAddress', 'source_recipient_local_part' => 'getSourceRecipientLocalPart', 'source_ingest_domain_id' => 'getSourceIngestDomainId', 'source_profile_id' => 'getSourceProfileId', 'source_profile_local_part' => 'getSourceProfileLocalPart', 'source_profile_display_name' => 'getSourceProfileDisplayName', 'status' => 'getStatus', 'primary_screenshot_id' => 'getPrimaryScreenshotId', 'requested_providers' => 'getRequestedProviders', 'imported_providers' => 'getImportedProviders', 'warnings' => 'getWarnings', 'provider_message_ids' => 'getProviderMessageIds', 'latest_error' => 'getLatestError', 'target_count' => 'getTargetCount', 'screenshot_count' => 'getScreenshotCount', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'thumbnail' => 'getThumbnail', 'qa_bundle' => 'getQaBundle', 'folder_id' => 'getFolderId']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['run_id' => 'uuid', 'email_id' => 'uuid', 'source_type' => null, 'source_inbox_id' => 'uuid', 'source_alias' => null, 'source_external_id' => null, 'source_from' => null, 'source_to' => null, 'source_subject' => null, 'source_message_id' => null, 'source_size_bytes' => 'int64', 'source_storage_provider' => null, 'source_storage_bucket' => null, 'source_storage_object_key' => null, 'source_storage_region' => null, 'source_storage_endpoint' => null, 'source_storage_public_base_url' => null, 'source_recipient_email_address' => null, 'source_recipient_local_part' => null, 'source_ingest_domain_id' => 'uuid', 'source_profile_id' => 'uuid', 'source_profile_local_part' => null, 'source_profile_display_name' => null, 'status' => null, 'primary_screenshot_id' => 'uuid', 'requested_providers' => null, 'imported_providers' => null, 'warnings' => null, 'provider_message_ids' => null, 'latest_error' => null, 'target_count' => 'int64', 'screenshot_count' => 'int64', 'created_at' => 'date-time', 'updated_at' => 'date-time', 'thumbnail' => null, 'qa_bundle' => null, 'folder_id' => 'uuid']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'DevicePreviewRunDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['run_id' => false, 'email_id' => true, 'source_type' => false, 'source_inbox_id' => true, 'source_alias' => true, 'source_external_id' => true, 'source_from' => true, 'source_to' => true, 'source_subject' => true, 'source_message_id' => true, 'source_size_bytes' => true, 'source_storage_provider' => true, 'source_storage_bucket' => true, 'source_storage_object_key' => true, 'source_storage_region' => true, 'source_storage_endpoint' => true, 'source_storage_public_base_url' => true, 'source_recipient_email_address' => true, 'source_recipient_local_part' => true, 'source_ingest_domain_id' => true, 'source_profile_id' => true, 'source_profile_local_part' => true, 'source_profile_display_name' => true, 'status' => false, 'primary_screenshot_id' => true, 'requested_providers' => true, 'imported_providers' => true, 'warnings' => true, 'provider_message_ids' => true, 'latest_error' => true, 'target_count' => false, 'screenshot_count' => false, 'created_at' => false, 'updated_at' => false, 'thumbnail' => true, 'qa_bundle' => true, 'folder_id' => true]

$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 = ['run_id' => 'string', 'email_id' => 'string', 'source_type' => 'string', 'source_inbox_id' => 'string', 'source_alias' => 'string', 'source_external_id' => 'string', 'source_from' => 'string', 'source_to' => 'string[]', 'source_subject' => 'string', 'source_message_id' => 'string', 'source_size_bytes' => 'int', 'source_storage_provider' => 'string', 'source_storage_bucket' => 'string', 'source_storage_object_key' => 'string', 'source_storage_region' => 'string', 'source_storage_endpoint' => 'string', 'source_storage_public_base_url' => 'string', 'source_recipient_email_address' => 'string', 'source_recipient_local_part' => 'string', 'source_ingest_domain_id' => 'string', 'source_profile_id' => 'string', 'source_profile_local_part' => 'string', 'source_profile_display_name' => 'string', 'status' => 'string', 'primary_screenshot_id' => 'string', 'requested_providers' => 'string[]', 'imported_providers' => 'string[]', 'warnings' => 'string[]', 'provider_message_ids' => 'array<string,string>', 'latest_error' => 'string', 'target_count' => 'int', 'screenshot_count' => 'int', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'thumbnail' => '\\MailSlurp\\Models\\DevicePreviewRunDtoThumbnail', 'qa_bundle' => '\\MailSlurp\\Models\\DevicePreviewRunDtoQaBundle', 'folder_id' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['run_id' => 'setRunId', 'email_id' => 'setEmailId', 'source_type' => 'setSourceType', 'source_inbox_id' => 'setSourceInboxId', 'source_alias' => 'setSourceAlias', 'source_external_id' => 'setSourceExternalId', 'source_from' => 'setSourceFrom', 'source_to' => 'setSourceTo', 'source_subject' => 'setSourceSubject', 'source_message_id' => 'setSourceMessageId', 'source_size_bytes' => 'setSourceSizeBytes', 'source_storage_provider' => 'setSourceStorageProvider', 'source_storage_bucket' => 'setSourceStorageBucket', 'source_storage_object_key' => 'setSourceStorageObjectKey', 'source_storage_region' => 'setSourceStorageRegion', 'source_storage_endpoint' => 'setSourceStorageEndpoint', 'source_storage_public_base_url' => 'setSourceStoragePublicBaseUrl', 'source_recipient_email_address' => 'setSourceRecipientEmailAddress', 'source_recipient_local_part' => 'setSourceRecipientLocalPart', 'source_ingest_domain_id' => 'setSourceIngestDomainId', 'source_profile_id' => 'setSourceProfileId', 'source_profile_local_part' => 'setSourceProfileLocalPart', 'source_profile_display_name' => 'setSourceProfileDisplayName', 'status' => 'setStatus', 'primary_screenshot_id' => 'setPrimaryScreenshotId', 'requested_providers' => 'setRequestedProviders', 'imported_providers' => 'setImportedProviders', 'warnings' => 'setWarnings', 'provider_message_ids' => 'setProviderMessageIds', 'latest_error' => 'setLatestError', 'target_count' => 'setTargetCount', 'screenshot_count' => 'setScreenshotCount', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'thumbnail' => 'setThumbnail', 'qa_bundle' => 'setQaBundle', 'folder_id' => 'setFolderId']

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime —

getEmailId()

Gets email_id

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

getFolderId()

Gets folder_id

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

getImportedProviders()

Gets imported_providers

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

getLatestError()

Gets latest_error

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPrimaryScreenshotId()

Gets primary_screenshot_id

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

getProviderMessageIds()

Gets provider_message_ids

public getProviderMessageIds() : array<string, string>|null
Return values
array<string, string>|null —

getRequestedProviders()

Gets requested_providers

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

getScreenshotCount()

Gets screenshot_count

public getScreenshotCount() : int
Return values
int —

getSourceAlias()

Gets source_alias

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

getSourceExternalId()

Gets source_external_id

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

getSourceFrom()

Gets source_from

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

getSourceInboxId()

Gets source_inbox_id

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

getSourceIngestDomainId()

Gets source_ingest_domain_id

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

getSourceMessageId()

Gets source_message_id

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

getSourceProfileDisplayName()

Gets source_profile_display_name

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

getSourceProfileId()

Gets source_profile_id

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

getSourceProfileLocalPart()

Gets source_profile_local_part

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

getSourceRecipientEmailAddress()

Gets source_recipient_email_address

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

getSourceRecipientLocalPart()

Gets source_recipient_local_part

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

getSourceSizeBytes()

Gets source_size_bytes

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

getSourceStorageBucket()

Gets source_storage_bucket

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

getSourceStorageEndpoint()

Gets source_storage_endpoint

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

getSourceStorageObjectKey()

Gets source_storage_object_key

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

getSourceStorageProvider()

Gets source_storage_provider

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

getSourceStoragePublicBaseUrl()

Gets source_storage_public_base_url

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

getSourceStorageRegion()

Gets source_storage_region

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

getSourceSubject()

Gets source_subject

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

getSourceTo()

Gets source_to

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

getSourceType()

Gets source_type

public getSourceType() : string
Return values
string —

getSourceTypeAllowableValues()

Gets allowable values of the enum

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

getStatusAllowableValues()

Gets allowable values of the enum

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

getTargetCount()

Gets target_count

public getTargetCount() : int
Return values
int —

getters()

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

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

getUpdatedAt()

Gets updated_at

public getUpdatedAt() : DateTime
Return values
DateTime —

getWarnings()

Gets warnings

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

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

setCreatedAt()

Sets created_at

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

created_at

Return values
self —

setEmailId()

Sets email_id

public setEmailId(string|null $email_id) : self
Parameters
$email_id : string|null

email_id

Return values
self —

setFolderId()

Sets folder_id

public setFolderId(string|null $folder_id) : self
Parameters
$folder_id : string|null

folder_id

Return values
self —

setImportedProviders()

Sets imported_providers

public setImportedProviders(array<string|int, string>|null $imported_providers) : self
Parameters
$imported_providers : array<string|int, string>|null

imported_providers

Return values
self —

setLatestError()

Sets latest_error

public setLatestError(string|null $latest_error) : self
Parameters
$latest_error : string|null

Latest run-level error, if the preview run was blocked or failed after creation.

Return values
self —

setPrimaryScreenshotId()

Sets primary_screenshot_id

public setPrimaryScreenshotId(string|null $primary_screenshot_id) : self
Parameters
$primary_screenshot_id : string|null

primary_screenshot_id

Return values
self —

setProviderMessageIds()

Sets provider_message_ids

public setProviderMessageIds(array<string, string>|null $provider_message_ids) : self
Parameters
$provider_message_ids : array<string, string>|null

provider_message_ids

Return values
self —

setRequestedProviders()

Sets requested_providers

public setRequestedProviders(array<string|int, string>|null $requested_providers) : self
Parameters
$requested_providers : array<string|int, string>|null

requested_providers

Return values
self —

setRunId()

Sets run_id

public setRunId(string $run_id) : self
Parameters
$run_id : string

run_id

Return values
self —

setScreenshotCount()

Sets screenshot_count

public setScreenshotCount(int $screenshot_count) : self
Parameters
$screenshot_count : int

screenshot_count

Return values
self —

setSourceAlias()

Sets source_alias

public setSourceAlias(string|null $source_alias) : self
Parameters
$source_alias : string|null

source_alias

Return values
self —

setSourceExternalId()

Sets source_external_id

public setSourceExternalId(string|null $source_external_id) : self
Parameters
$source_external_id : string|null

source_external_id

Return values
self —

setSourceFrom()

Sets source_from

public setSourceFrom(string|null $source_from) : self
Parameters
$source_from : string|null

source_from

Return values
self —

setSourceInboxId()

Sets source_inbox_id

public setSourceInboxId(string|null $source_inbox_id) : self
Parameters
$source_inbox_id : string|null

source_inbox_id

Return values
self —

setSourceIngestDomainId()

Sets source_ingest_domain_id

public setSourceIngestDomainId(string|null $source_ingest_domain_id) : self
Parameters
$source_ingest_domain_id : string|null

source_ingest_domain_id

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 —

setSourceProfileDisplayName()

Sets source_profile_display_name

public setSourceProfileDisplayName(string|null $source_profile_display_name) : self
Parameters
$source_profile_display_name : string|null

source_profile_display_name

Return values
self —

setSourceProfileId()

Sets source_profile_id

public setSourceProfileId(string|null $source_profile_id) : self
Parameters
$source_profile_id : string|null

source_profile_id

Return values
self —

setSourceProfileLocalPart()

Sets source_profile_local_part

public setSourceProfileLocalPart(string|null $source_profile_local_part) : self
Parameters
$source_profile_local_part : string|null

source_profile_local_part

Return values
self —

setSourceRecipientEmailAddress()

Sets source_recipient_email_address

public setSourceRecipientEmailAddress(string|null $source_recipient_email_address) : self
Parameters
$source_recipient_email_address : string|null

source_recipient_email_address

Return values
self —

setSourceRecipientLocalPart()

Sets source_recipient_local_part

public setSourceRecipientLocalPart(string|null $source_recipient_local_part) : self
Parameters
$source_recipient_local_part : string|null

source_recipient_local_part

Return values
self —

setSourceSizeBytes()

Sets source_size_bytes

public setSourceSizeBytes(int|null $source_size_bytes) : self
Parameters
$source_size_bytes : int|null

source_size_bytes

Return values
self —

setSourceStorageBucket()

Sets source_storage_bucket

public setSourceStorageBucket(string|null $source_storage_bucket) : self
Parameters
$source_storage_bucket : string|null

source_storage_bucket

Return values
self —

setSourceStorageEndpoint()

Sets source_storage_endpoint

public setSourceStorageEndpoint(string|null $source_storage_endpoint) : self
Parameters
$source_storage_endpoint : string|null

source_storage_endpoint

Return values
self —

setSourceStorageObjectKey()

Sets source_storage_object_key

public setSourceStorageObjectKey(string|null $source_storage_object_key) : self
Parameters
$source_storage_object_key : string|null

source_storage_object_key

Return values
self —

setSourceStorageProvider()

Sets source_storage_provider

public setSourceStorageProvider(string|null $source_storage_provider) : self
Parameters
$source_storage_provider : string|null

source_storage_provider

Return values
self —

setSourceStoragePublicBaseUrl()

Sets source_storage_public_base_url

public setSourceStoragePublicBaseUrl(string|null $source_storage_public_base_url) : self
Parameters
$source_storage_public_base_url : string|null

source_storage_public_base_url

Return values
self —

setSourceStorageRegion()

Sets source_storage_region

public setSourceStorageRegion(string|null $source_storage_region) : self
Parameters
$source_storage_region : string|null

source_storage_region

Return values
self —

setSourceSubject()

Sets source_subject

public setSourceSubject(string|null $source_subject) : self
Parameters
$source_subject : string|null

source_subject

Return values
self —

setSourceTo()

Sets source_to

public setSourceTo(array<string|int, string>|null $source_to) : self
Parameters
$source_to : array<string|int, string>|null

source_to

Return values
self —

setSourceType()

Sets source_type

public setSourceType(string $source_type) : self
Parameters
$source_type : string

source_type

Return values
self —

setStatus()

Sets status

public setStatus(string $status) : self
Parameters
$status : string

status

Return values
self —

setTargetCount()

Sets target_count

public setTargetCount(int $target_count) : self
Parameters
$target_count : int

target_count

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

setUpdatedAt()

Sets updated_at

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

updated_at

Return values
self —

setWarnings()

Sets warnings

public setWarnings(array<string|int, string>|null $warnings) : self
Parameters
$warnings : array<string|int, string>|null

warnings

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

Search results