HomeExperienceDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
HomeExperienceDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- HOME_VARIANT_CHILD = 'CHILD'
- HOME_VARIANT_NEW_USER = 'NEW_USER'
- HOME_VARIANT_RETURNING = 'RETURNING'
- PERSONA_DEVELOPER = 'DEVELOPER'
- PERSONA_MARKETER = 'MARKETER'
- PERSONA_OPS = 'OPS'
- PERSONA_OTHER = 'OTHER'
- PERSONA_QA = 'QA'
- PERSONA_SUPPORT = 'SUPPORT'
- PRIMARY_PATH_AUTOMATIONS = 'AUTOMATIONS'
- PRIMARY_PATH_AUTOMATIONS_AI = 'AUTOMATIONS_AI'
- PRIMARY_PATH_DEVELOPERS = 'DEVELOPERS'
- PRIMARY_PATH_EMAIL = 'EMAIL'
- PRIMARY_PATH_EXTRACT = 'EXTRACT'
- PRIMARY_PATH_OBSERVE = 'OBSERVE'
- PRIMARY_PATH_PHONE = 'PHONE'
- PRIMARY_PATH_TEST = 'TEST'
- PRIMARY_PATH_UNDECIDED = 'UNDECIDED'
- SECONDARY_PATHS_AUTOMATIONS = 'AUTOMATIONS'
- SECONDARY_PATHS_AUTOMATIONS_AI = 'AUTOMATIONS_AI'
- SECONDARY_PATHS_DEVELOPERS = 'DEVELOPERS'
- SECONDARY_PATHS_EMAIL = 'EMAIL'
- SECONDARY_PATHS_EXTRACT = 'EXTRACT'
- SECONDARY_PATHS_OBSERVE = 'OBSERVE'
- SECONDARY_PATHS_PHONE = 'PHONE'
- SECONDARY_PATHS_TEST = 'TEST'
- SECONDARY_PATHS_UNDECIDED = 'UNDECIDED'
- TEAM_SIZE_ENTERPRISE = 'ENTERPRISE'
- TEAM_SIZE_SOLO = 'SOLO'
- TEAM_SIZE_TEAM = 'TEAM'
- $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
- getChecklist() : HomeExperienceDtoChecklist|null
- Gets checklist
- getFirstValue() : HomeExperienceFirstValueDto
- Gets first_value
- getHomeVariant() : string
- Gets home_variant
- getHomeVariantAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getPersona() : string|null
- Gets persona
- getPersonaAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getPrimaryPath() : string
- Gets primary_path
- getPrimaryPathAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSecondaryPaths() : array<string|int, string>|null
- Gets secondary_paths
- getSecondaryPathsAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTeamSize() : string|null
- Gets team_size
- getTeamSizeAllowableValues() : 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)
- getUpgradeContext() : HomeExperienceDtoUpgradeContext|null
- Gets upgrade_context
- getVersion() : string
- Gets version
- 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
- setChecklist() : self
- Sets checklist
- setFirstValue() : self
- Sets first_value
- setHomeVariant() : self
- Sets home_variant
- setPersona() : self
- Sets persona
- setPrimaryPath() : self
- Sets primary_path
- setSecondaryPaths() : self
- Sets secondary_paths
- setTeamSize() : self
- Sets team_size
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUpgradeContext() : self
- Sets upgrade_context
- setVersion() : self
- Sets version
- 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
HOME_VARIANT_CHILD
public
mixed
HOME_VARIANT_CHILD
= 'CHILD'
HOME_VARIANT_NEW_USER
public
mixed
HOME_VARIANT_NEW_USER
= 'NEW_USER'
HOME_VARIANT_RETURNING
public
mixed
HOME_VARIANT_RETURNING
= 'RETURNING'
PERSONA_DEVELOPER
public
mixed
PERSONA_DEVELOPER
= 'DEVELOPER'
PERSONA_MARKETER
public
mixed
PERSONA_MARKETER
= 'MARKETER'
PERSONA_OPS
public
mixed
PERSONA_OPS
= 'OPS'
PERSONA_OTHER
public
mixed
PERSONA_OTHER
= 'OTHER'
PERSONA_QA
public
mixed
PERSONA_QA
= 'QA'
PERSONA_SUPPORT
public
mixed
PERSONA_SUPPORT
= 'SUPPORT'
PRIMARY_PATH_AUTOMATIONS
public
mixed
PRIMARY_PATH_AUTOMATIONS
= 'AUTOMATIONS'
PRIMARY_PATH_AUTOMATIONS_AI
public
mixed
PRIMARY_PATH_AUTOMATIONS_AI
= 'AUTOMATIONS_AI'
PRIMARY_PATH_DEVELOPERS
public
mixed
PRIMARY_PATH_DEVELOPERS
= 'DEVELOPERS'
PRIMARY_PATH_EMAIL
public
mixed
PRIMARY_PATH_EMAIL
= 'EMAIL'
PRIMARY_PATH_EXTRACT
public
mixed
PRIMARY_PATH_EXTRACT
= 'EXTRACT'
PRIMARY_PATH_OBSERVE
public
mixed
PRIMARY_PATH_OBSERVE
= 'OBSERVE'
PRIMARY_PATH_PHONE
public
mixed
PRIMARY_PATH_PHONE
= 'PHONE'
PRIMARY_PATH_TEST
public
mixed
PRIMARY_PATH_TEST
= 'TEST'
PRIMARY_PATH_UNDECIDED
public
mixed
PRIMARY_PATH_UNDECIDED
= 'UNDECIDED'
SECONDARY_PATHS_AUTOMATIONS
public
mixed
SECONDARY_PATHS_AUTOMATIONS
= 'AUTOMATIONS'
SECONDARY_PATHS_AUTOMATIONS_AI
public
mixed
SECONDARY_PATHS_AUTOMATIONS_AI
= 'AUTOMATIONS_AI'
SECONDARY_PATHS_DEVELOPERS
public
mixed
SECONDARY_PATHS_DEVELOPERS
= 'DEVELOPERS'
SECONDARY_PATHS_EMAIL
public
mixed
SECONDARY_PATHS_EMAIL
= 'EMAIL'
SECONDARY_PATHS_EXTRACT
public
mixed
SECONDARY_PATHS_EXTRACT
= 'EXTRACT'
SECONDARY_PATHS_OBSERVE
public
mixed
SECONDARY_PATHS_OBSERVE
= 'OBSERVE'
SECONDARY_PATHS_PHONE
public
mixed
SECONDARY_PATHS_PHONE
= 'PHONE'
SECONDARY_PATHS_TEST
public
mixed
SECONDARY_PATHS_TEST
= 'TEST'
SECONDARY_PATHS_UNDECIDED
public
mixed
SECONDARY_PATHS_UNDECIDED
= 'UNDECIDED'
TEAM_SIZE_ENTERPRISE
public
mixed
TEAM_SIZE_ENTERPRISE
= 'ENTERPRISE'
TEAM_SIZE_SOLO
public
mixed
TEAM_SIZE_SOLO
= 'SOLO'
TEAM_SIZE_TEAM
public
mixed
TEAM_SIZE_TEAM
= 'TEAM'
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
= ['version' => 'version', 'home_variant' => 'homeVariant', 'primary_path' => 'primaryPath', 'secondary_paths' => 'secondaryPaths', 'persona' => 'persona', 'team_size' => 'teamSize', 'checklist' => 'checklist', 'first_value' => 'firstValue', 'upgrade_context' => 'upgradeContext']
$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
= ['version' => 'getVersion', 'home_variant' => 'getHomeVariant', 'primary_path' => 'getPrimaryPath', 'secondary_paths' => 'getSecondaryPaths', 'persona' => 'getPersona', 'team_size' => 'getTeamSize', 'checklist' => 'getChecklist', 'first_value' => 'getFirstValue', 'upgrade_context' => 'getUpgradeContext']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['version' => null, 'home_variant' => null, 'primary_path' => null, 'secondary_paths' => null, 'persona' => null, 'team_size' => null, 'checklist' => null, 'first_value' => null, 'upgrade_context' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'HomeExperienceDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['version' => false, 'home_variant' => false, 'primary_path' => false, 'secondary_paths' => true, 'persona' => true, 'team_size' => true, 'checklist' => true, 'first_value' => false, 'upgrade_context' => 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
= ['version' => 'string', 'home_variant' => 'string', 'primary_path' => 'string', 'secondary_paths' => 'string[]', 'persona' => 'string', 'team_size' => 'string', 'checklist' => '\\MailSlurp\\Models\\HomeExperienceDtoChecklist', 'first_value' => '\\MailSlurp\\Models\\HomeExperienceFirstValueDto', 'upgrade_context' => '\\MailSlurp\\Models\\HomeExperienceDtoUpgradeContext']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['version' => 'setVersion', 'home_variant' => 'setHomeVariant', 'primary_path' => 'setPrimaryPath', 'secondary_paths' => 'setSecondaryPaths', 'persona' => 'setPersona', 'team_size' => 'setTeamSize', 'checklist' => 'setChecklist', 'first_value' => 'setFirstValue', 'upgrade_context' => 'setUpgradeContext']
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> —getChecklist()
Gets checklist
public
getChecklist() : HomeExperienceDtoChecklist|null
Return values
HomeExperienceDtoChecklist|null —getFirstValue()
Gets first_value
public
getFirstValue() : HomeExperienceFirstValueDto
Return values
HomeExperienceFirstValueDto —getHomeVariant()
Gets home_variant
public
getHomeVariant() : string
Return values
string —getHomeVariantAllowableValues()
Gets allowable values of the enum
public
getHomeVariantAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPersona()
Gets persona
public
getPersona() : string|null
Return values
string|null —getPersonaAllowableValues()
Gets allowable values of the enum
public
getPersonaAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getPrimaryPath()
Gets primary_path
public
getPrimaryPath() : string
Return values
string —getPrimaryPathAllowableValues()
Gets allowable values of the enum
public
getPrimaryPathAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSecondaryPaths()
Gets secondary_paths
public
getSecondaryPaths() : array<string|int, string>|null
Return values
array<string|int, string>|null —getSecondaryPathsAllowableValues()
Gets allowable values of the enum
public
getSecondaryPathsAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTeamSize()
Gets team_size
public
getTeamSize() : string|null
Return values
string|null —getTeamSizeAllowableValues()
Gets allowable values of the enum
public
getTeamSizeAllowableValues() : 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> —getUpgradeContext()
Gets upgrade_context
public
getUpgradeContext() : HomeExperienceDtoUpgradeContext|null
Return values
HomeExperienceDtoUpgradeContext|null —getVersion()
Gets version
public
getVersion() : string
Return values
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> —setChecklist()
Sets checklist
public
setChecklist(HomeExperienceDtoChecklist|null $checklist) : self
Parameters
- $checklist : HomeExperienceDtoChecklist|null
-
checklist
Return values
self —setFirstValue()
Sets first_value
public
setFirstValue(HomeExperienceFirstValueDto $first_value) : self
Parameters
- $first_value : HomeExperienceFirstValueDto
-
first_value
Return values
self —setHomeVariant()
Sets home_variant
public
setHomeVariant(string $home_variant) : self
Parameters
- $home_variant : string
-
home_variant
Return values
self —setPersona()
Sets persona
public
setPersona(string|null $persona) : self
Parameters
- $persona : string|null
-
persona
Return values
self —setPrimaryPath()
Sets primary_path
public
setPrimaryPath(string $primary_path) : self
Parameters
- $primary_path : string
-
primary_path
Return values
self —setSecondaryPaths()
Sets secondary_paths
public
setSecondaryPaths(array<string|int, string>|null $secondary_paths) : self
Parameters
- $secondary_paths : array<string|int, string>|null
-
secondary_paths
Return values
self —setTeamSize()
Sets team_size
public
setTeamSize(string|null $team_size) : self
Parameters
- $team_size : string|null
-
team_size
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> —setUpgradeContext()
Sets upgrade_context
public
setUpgradeContext(HomeExperienceDtoUpgradeContext|null $upgrade_context) : self
Parameters
- $upgrade_context : HomeExperienceDtoUpgradeContext|null
-
upgrade_context
Return values
self —setVersion()
Sets version
public
setVersion(string $version) : self
Parameters
- $version : string
-
version
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>