Documentation

DevicePreviewSharedRunDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DevicePreviewSharedRunDto 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
getModelName()  : string
The original name of the model.
getPrimaryScreenshotId()  : string|null
Gets primary_screenshot_id
getRunId()  : string
Gets run_id
getScreenshotCount()  : int
Gets screenshot_count
getSourceAlias()  : string|null
Gets source_alias
getSourceFrom()  : string|null
Gets source_from
getSourceProfileDisplayName()  : string|null
Gets source_profile_display_name
getSourceProfileLocalPart()  : string|null
Gets source_profile_local_part
getSourceRecipientEmailAddress()  : string|null
Gets source_recipient_email_address
getSourceRecipientLocalPart()  : string|null
Gets source_recipient_local_part
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)
getUpdatedAt()  : DateTime
Gets updated_at
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
setPrimaryScreenshotId()  : self
Sets primary_screenshot_id
setRunId()  : self
Sets run_id
setScreenshotCount()  : self
Sets screenshot_count
setSourceAlias()  : self
Sets source_alias
setSourceFrom()  : self
Sets source_from
setSourceProfileDisplayName()  : self
Sets source_profile_display_name
setSourceProfileLocalPart()  : self
Sets source_profile_local_part
setSourceRecipientEmailAddress()  : self
Sets source_recipient_email_address
setSourceRecipientLocalPart()  : self
Sets source_recipient_local_part
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)
setUpdatedAt()  : self
Sets updated_at
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 = ['run_id' => 'runId', 'source_type' => 'sourceType', 'source_alias' => 'sourceAlias', 'source_subject' => 'sourceSubject', 'source_from' => 'sourceFrom', 'source_to' => 'sourceTo', 'source_recipient_email_address' => 'sourceRecipientEmailAddress', 'source_recipient_local_part' => 'sourceRecipientLocalPart', 'source_profile_local_part' => 'sourceProfileLocalPart', 'source_profile_display_name' => 'sourceProfileDisplayName', 'status' => 'status', 'primary_screenshot_id' => 'primaryScreenshotId', 'target_count' => 'targetCount', 'screenshot_count' => 'screenshotCount', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$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', 'source_type' => 'getSourceType', 'source_alias' => 'getSourceAlias', 'source_subject' => 'getSourceSubject', 'source_from' => 'getSourceFrom', 'source_to' => 'getSourceTo', 'source_recipient_email_address' => 'getSourceRecipientEmailAddress', 'source_recipient_local_part' => 'getSourceRecipientLocalPart', 'source_profile_local_part' => 'getSourceProfileLocalPart', 'source_profile_display_name' => 'getSourceProfileDisplayName', 'status' => 'getStatus', 'primary_screenshot_id' => 'getPrimaryScreenshotId', 'target_count' => 'getTargetCount', 'screenshot_count' => 'getScreenshotCount', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['run_id' => 'uuid', 'source_type' => null, 'source_alias' => null, 'source_subject' => null, 'source_from' => null, 'source_to' => null, 'source_recipient_email_address' => null, 'source_recipient_local_part' => null, 'source_profile_local_part' => null, 'source_profile_display_name' => null, 'status' => null, 'primary_screenshot_id' => 'uuid', 'target_count' => 'int64', 'screenshot_count' => 'int64', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'DevicePreviewSharedRunDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['run_id' => false, 'source_type' => false, 'source_alias' => true, 'source_subject' => true, 'source_from' => true, 'source_to' => true, 'source_recipient_email_address' => true, 'source_recipient_local_part' => true, 'source_profile_local_part' => true, 'source_profile_display_name' => true, 'status' => false, 'primary_screenshot_id' => true, 'target_count' => false, 'screenshot_count' => 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 = ['run_id' => 'string', 'source_type' => 'string', 'source_alias' => 'string', 'source_subject' => 'string', 'source_from' => 'string', 'source_to' => 'string[]', 'source_recipient_email_address' => 'string', 'source_recipient_local_part' => 'string', 'source_profile_local_part' => 'string', 'source_profile_display_name' => 'string', 'status' => 'string', 'primary_screenshot_id' => 'string', 'target_count' => 'int', 'screenshot_count' => 'int', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['run_id' => 'setRunId', 'source_type' => 'setSourceType', 'source_alias' => 'setSourceAlias', 'source_subject' => 'setSourceSubject', 'source_from' => 'setSourceFrom', 'source_to' => 'setSourceTo', 'source_recipient_email_address' => 'setSourceRecipientEmailAddress', 'source_recipient_local_part' => 'setSourceRecipientLocalPart', 'source_profile_local_part' => 'setSourceProfileLocalPart', 'source_profile_display_name' => 'setSourceProfileDisplayName', 'status' => 'setStatus', 'primary_screenshot_id' => 'setPrimaryScreenshotId', 'target_count' => 'setTargetCount', 'screenshot_count' => 'setScreenshotCount', '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 —

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

getPrimaryScreenshotId()

Gets primary_screenshot_id

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

getSourceProfileDisplayName()

Gets source_profile_display_name

public getSourceProfileDisplayName() : 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 —

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 —

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

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

setCreatedAt()

Sets created_at

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

created_at

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 —

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 —

setSourceFrom()

Sets source_from

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

source_from

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 —

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 —

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 —

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