UserDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
UserDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- ACCOUNT_REGION_EU_WEST_1 = 'EU_WEST_1'
- ACCOUNT_REGION_EU_WEST_1_ACCOUNT_BYTEWISE = 'EU_WEST_1_ACCOUNT_BYTEWISE'
- ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_1 = 'EU_WEST_1_ACCOUNT_SES_1'
- ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_2 = 'EU_WEST_1_ACCOUNT_SES_2'
- ACCOUNT_REGION_EU_WEST_1_ACCOUNT_STAGING = 'EU_WEST_1_ACCOUNT_STAGING'
- ACCOUNT_REGION_US_EAST_1 = 'US_EAST_1'
- ACCOUNT_REGION_US_EAST_1_ACCOUNT_SES_1 = 'US_EAST_1_ACCOUNT_SES_1'
- ACCOUNT_REGION_US_EAST_1_ACCOUNT_STAGING = 'US_EAST_1_ACCOUNT_STAGING'
- ACCOUNT_REGION_US_WEST_2 = 'US_WEST_2'
- ACCOUNT_REGION_US_WEST_2_ACCOUNT_BYTEWISE = 'US_WEST_2_ACCOUNT_BYTEWISE'
- ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_1 = 'US_WEST_2_ACCOUNT_SES_1'
- ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_2 = 'US_WEST_2_ACCOUNT_SES_2'
- ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_3 = 'US_WEST_2_ACCOUNT_SES_3'
- ACCOUNT_REGION_US_WEST_2_ACCOUNT_STAGING = 'US_WEST_2_ACCOUNT_STAGING'
- DISCRIMINATOR = null
- USER_TYPE_CHILD_ADMIN = 'CHILD_ADMIN'
- USER_TYPE_CHILD_SOLO = 'CHILD_SOLO'
- USER_TYPE_CHILD_TEAM = 'CHILD_TEAM'
- USER_TYPE_SOLO = 'SOLO'
- VERIFIED_PENDING = 'PENDING'
- VERIFIED_PHONE_PENDING = 'PENDING'
- VERIFIED_PHONE_VERIFIED = 'VERIFIED'
- VERIFIED_VERIFIED = 'VERIFIED'
- $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
- getAccessLinkSendResult() : UserDtoAccessLinkSendResult|null
- Gets access_link_send_result
- getAccountRegion() : string|null
- Gets account_region
- getAccountRegionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getAddNewContacts() : bool|null
- Gets add_new_contacts
- getApiAccessToken() : UserDtoApiAccessToken|null
- Gets api_access_token
- getApiKey() : string
- Gets api_key
- getChargePending() : bool|null
- Gets charge_pending
- getCreated() : DateTime|null
- Gets created
- getCustomerId() : string|null
- Gets customer_id
- getEmailAddress() : string
- Gets email_address
- getEmailAddressMd5() : string
- Gets email_address_md5
- getEnableSms() : bool|null
- Gets enable_sms
- getFrozenMessage() : string|null
- Gets frozen_message
- getHasOnboarded() : bool|null
- Gets has_onboarded
- getHasPassword() : bool
- Gets has_password
- getId() : string
- Gets id
- getImapPassword() : string|null
- Gets imap_password
- getImapUsername() : string|null
- Gets imap_username
- getIsFrozen() : bool
- Gets is_frozen
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getOrganization() : string|null
- Gets organization
- getPhoneNumber() : string|null
- Gets phone_number
- getSmtpPassword() : string|null
- Gets smtp_password
- getSmtpUsername() : string|null
- Gets smtp_username
- getSsoProvider() : string|null
- Gets sso_provider
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUnsubscribed() : bool|null
- Gets unsubscribed
- getUserType() : string|null
- Gets user_type
- getUserTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getVendorEmailAddress() : string|null
- Gets vendor_email_address
- getVerified() : string|null
- Gets verified
- getVerifiedAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getVerifiedPhone() : string|null
- Gets verified_phone
- getVerifiedPhoneAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- 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
- setAccessLinkSendResult() : self
- Sets access_link_send_result
- setAccountRegion() : self
- Sets account_region
- setAddNewContacts() : self
- Sets add_new_contacts
- setApiAccessToken() : self
- Sets api_access_token
- setApiKey() : self
- Sets api_key
- setChargePending() : self
- Sets charge_pending
- setCreated() : self
- Sets created
- setCustomerId() : self
- Sets customer_id
- setEmailAddress() : self
- Sets email_address
- setEmailAddressMd5() : self
- Sets email_address_md5
- setEnableSms() : self
- Sets enable_sms
- setFrozenMessage() : self
- Sets frozen_message
- setHasOnboarded() : self
- Sets has_onboarded
- setHasPassword() : self
- Sets has_password
- setId() : self
- Sets id
- setImapPassword() : self
- Sets imap_password
- setImapUsername() : self
- Sets imap_username
- setIsFrozen() : self
- Sets is_frozen
- setName() : self
- Sets name
- setOrganization() : self
- Sets organization
- setPhoneNumber() : self
- Sets phone_number
- setSmtpPassword() : self
- Sets smtp_password
- setSmtpUsername() : self
- Sets smtp_username
- setSsoProvider() : self
- Sets sso_provider
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUnsubscribed() : self
- Sets unsubscribed
- setUserType() : self
- Sets user_type
- setVendorEmailAddress() : self
- Sets vendor_email_address
- setVerified() : self
- Sets verified
- setVerifiedPhone() : self
- Sets verified_phone
- 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
ACCOUNT_REGION_EU_WEST_1
public
mixed
ACCOUNT_REGION_EU_WEST_1
= 'EU_WEST_1'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_BYTEWISE
public
mixed
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_BYTEWISE
= 'EU_WEST_1_ACCOUNT_BYTEWISE'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_1
public
mixed
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_1
= 'EU_WEST_1_ACCOUNT_SES_1'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_2
public
mixed
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_2
= 'EU_WEST_1_ACCOUNT_SES_2'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_STAGING
public
mixed
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_STAGING
= 'EU_WEST_1_ACCOUNT_STAGING'
ACCOUNT_REGION_US_EAST_1
public
mixed
ACCOUNT_REGION_US_EAST_1
= 'US_EAST_1'
ACCOUNT_REGION_US_EAST_1_ACCOUNT_SES_1
public
mixed
ACCOUNT_REGION_US_EAST_1_ACCOUNT_SES_1
= 'US_EAST_1_ACCOUNT_SES_1'
ACCOUNT_REGION_US_EAST_1_ACCOUNT_STAGING
public
mixed
ACCOUNT_REGION_US_EAST_1_ACCOUNT_STAGING
= 'US_EAST_1_ACCOUNT_STAGING'
ACCOUNT_REGION_US_WEST_2
public
mixed
ACCOUNT_REGION_US_WEST_2
= 'US_WEST_2'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_BYTEWISE
public
mixed
ACCOUNT_REGION_US_WEST_2_ACCOUNT_BYTEWISE
= 'US_WEST_2_ACCOUNT_BYTEWISE'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_1
public
mixed
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_1
= 'US_WEST_2_ACCOUNT_SES_1'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_2
public
mixed
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_2
= 'US_WEST_2_ACCOUNT_SES_2'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_3
public
mixed
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_3
= 'US_WEST_2_ACCOUNT_SES_3'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_STAGING
public
mixed
ACCOUNT_REGION_US_WEST_2_ACCOUNT_STAGING
= 'US_WEST_2_ACCOUNT_STAGING'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
USER_TYPE_CHILD_ADMIN
public
mixed
USER_TYPE_CHILD_ADMIN
= 'CHILD_ADMIN'
USER_TYPE_CHILD_SOLO
public
mixed
USER_TYPE_CHILD_SOLO
= 'CHILD_SOLO'
USER_TYPE_CHILD_TEAM
public
mixed
USER_TYPE_CHILD_TEAM
= 'CHILD_TEAM'
USER_TYPE_SOLO
public
mixed
USER_TYPE_SOLO
= 'SOLO'
VERIFIED_PENDING
public
mixed
VERIFIED_PENDING
= 'PENDING'
VERIFIED_PHONE_PENDING
public
mixed
VERIFIED_PHONE_PENDING
= 'PENDING'
VERIFIED_PHONE_VERIFIED
public
mixed
VERIFIED_PHONE_VERIFIED
= 'VERIFIED'
VERIFIED_VERIFIED
public
mixed
VERIFIED_VERIFIED
= 'VERIFIED'
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', 'api_key' => 'apiKey', 'email_address' => 'emailAddress', 'email_address_md5' => 'emailAddressMd5', 'created' => 'created', 'user_type' => 'userType', 'organization' => 'organization', 'verified' => 'verified', 'has_password' => 'hasPassword', 'is_frozen' => 'isFrozen', 'frozen_message' => 'frozenMessage', 'add_new_contacts' => 'addNewContacts', 'sso_provider' => 'ssoProvider', 'customer_id' => 'customerId', 'has_onboarded' => 'hasOnboarded', 'imap_username' => 'imapUsername', 'imap_password' => 'imapPassword', 'smtp_username' => 'smtpUsername', 'smtp_password' => 'smtpPassword', 'charge_pending' => 'chargePending', 'enable_sms' => 'enableSms', 'vendor_email_address' => 'vendorEmailAddress', 'unsubscribed' => 'unsubscribed', 'api_access_token' => 'apiAccessToken', 'phone_number' => 'phoneNumber', 'verified_phone' => 'verifiedPhone', 'account_region' => 'accountRegion', 'name' => 'name', 'access_link_send_result' => 'accessLinkSendResult']
$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
= ['id' => 'getId', 'api_key' => 'getApiKey', 'email_address' => 'getEmailAddress', 'email_address_md5' => 'getEmailAddressMd5', 'created' => 'getCreated', 'user_type' => 'getUserType', 'organization' => 'getOrganization', 'verified' => 'getVerified', 'has_password' => 'getHasPassword', 'is_frozen' => 'getIsFrozen', 'frozen_message' => 'getFrozenMessage', 'add_new_contacts' => 'getAddNewContacts', 'sso_provider' => 'getSsoProvider', 'customer_id' => 'getCustomerId', 'has_onboarded' => 'getHasOnboarded', 'imap_username' => 'getImapUsername', 'imap_password' => 'getImapPassword', 'smtp_username' => 'getSmtpUsername', 'smtp_password' => 'getSmtpPassword', 'charge_pending' => 'getChargePending', 'enable_sms' => 'getEnableSms', 'vendor_email_address' => 'getVendorEmailAddress', 'unsubscribed' => 'getUnsubscribed', 'api_access_token' => 'getApiAccessToken', 'phone_number' => 'getPhoneNumber', 'verified_phone' => 'getVerifiedPhone', 'account_region' => 'getAccountRegion', 'name' => 'getName', 'access_link_send_result' => 'getAccessLinkSendResult']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'api_key' => null, 'email_address' => null, 'email_address_md5' => null, 'created' => 'date-time', 'user_type' => null, 'organization' => 'uuid', 'verified' => null, 'has_password' => null, 'is_frozen' => null, 'frozen_message' => null, 'add_new_contacts' => null, 'sso_provider' => null, 'customer_id' => null, 'has_onboarded' => null, 'imap_username' => null, 'imap_password' => null, 'smtp_username' => null, 'smtp_password' => null, 'charge_pending' => null, 'enable_sms' => null, 'vendor_email_address' => null, 'unsubscribed' => null, 'api_access_token' => null, 'phone_number' => null, 'verified_phone' => null, 'account_region' => null, 'name' => null, 'access_link_send_result' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'UserDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'api_key' => false, 'email_address' => false, 'email_address_md5' => false, 'created' => true, 'user_type' => true, 'organization' => true, 'verified' => true, 'has_password' => false, 'is_frozen' => false, 'frozen_message' => true, 'add_new_contacts' => true, 'sso_provider' => true, 'customer_id' => true, 'has_onboarded' => true, 'imap_username' => true, 'imap_password' => true, 'smtp_username' => true, 'smtp_password' => true, 'charge_pending' => true, 'enable_sms' => true, 'vendor_email_address' => true, 'unsubscribed' => true, 'api_access_token' => true, 'phone_number' => true, 'verified_phone' => true, 'account_region' => true, 'name' => true, 'access_link_send_result' => 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
= ['id' => 'string', 'api_key' => 'string', 'email_address' => 'string', 'email_address_md5' => 'string', 'created' => '\\DateTime', 'user_type' => 'string', 'organization' => 'string', 'verified' => 'string', 'has_password' => 'bool', 'is_frozen' => 'bool', 'frozen_message' => 'string', 'add_new_contacts' => 'bool', 'sso_provider' => 'string', 'customer_id' => 'string', 'has_onboarded' => 'bool', 'imap_username' => 'string', 'imap_password' => 'string', 'smtp_username' => 'string', 'smtp_password' => 'string', 'charge_pending' => 'bool', 'enable_sms' => 'bool', 'vendor_email_address' => 'string', 'unsubscribed' => 'bool', 'api_access_token' => '\\MailSlurp\\Models\\UserDtoApiAccessToken', 'phone_number' => 'string', 'verified_phone' => 'string', 'account_region' => 'string', 'name' => 'string', 'access_link_send_result' => '\\MailSlurp\\Models\\UserDtoAccessLinkSendResult']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'api_key' => 'setApiKey', 'email_address' => 'setEmailAddress', 'email_address_md5' => 'setEmailAddressMd5', 'created' => 'setCreated', 'user_type' => 'setUserType', 'organization' => 'setOrganization', 'verified' => 'setVerified', 'has_password' => 'setHasPassword', 'is_frozen' => 'setIsFrozen', 'frozen_message' => 'setFrozenMessage', 'add_new_contacts' => 'setAddNewContacts', 'sso_provider' => 'setSsoProvider', 'customer_id' => 'setCustomerId', 'has_onboarded' => 'setHasOnboarded', 'imap_username' => 'setImapUsername', 'imap_password' => 'setImapPassword', 'smtp_username' => 'setSmtpUsername', 'smtp_password' => 'setSmtpPassword', 'charge_pending' => 'setChargePending', 'enable_sms' => 'setEnableSms', 'vendor_email_address' => 'setVendorEmailAddress', 'unsubscribed' => 'setUnsubscribed', 'api_access_token' => 'setApiAccessToken', 'phone_number' => 'setPhoneNumber', 'verified_phone' => 'setVerifiedPhone', 'account_region' => 'setAccountRegion', 'name' => 'setName', 'access_link_send_result' => 'setAccessLinkSendResult']
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> —getAccessLinkSendResult()
Gets access_link_send_result
public
getAccessLinkSendResult() : UserDtoAccessLinkSendResult|null
Return values
UserDtoAccessLinkSendResult|null —getAccountRegion()
Gets account_region
public
getAccountRegion() : string|null
Return values
string|null —getAccountRegionAllowableValues()
Gets allowable values of the enum
public
getAccountRegionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getAddNewContacts()
Gets add_new_contacts
public
getAddNewContacts() : bool|null
Return values
bool|null —getApiAccessToken()
Gets api_access_token
public
getApiAccessToken() : UserDtoApiAccessToken|null
Return values
UserDtoApiAccessToken|null —getApiKey()
Gets api_key
public
getApiKey() : string
Tags
Return values
string —getChargePending()
Gets charge_pending
public
getChargePending() : bool|null
Return values
bool|null —getCreated()
Gets created
public
getCreated() : DateTime|null
Return values
DateTime|null —getCustomerId()
Gets customer_id
public
getCustomerId() : string|null
Return values
string|null —getEmailAddress()
Gets email_address
public
getEmailAddress() : string
Return values
string —getEmailAddressMd5()
Gets email_address_md5
public
getEmailAddressMd5() : string
Return values
string —getEnableSms()
Gets enable_sms
public
getEnableSms() : bool|null
Return values
bool|null —getFrozenMessage()
Gets frozen_message
public
getFrozenMessage() : string|null
Return values
string|null —getHasOnboarded()
Gets has_onboarded
public
getHasOnboarded() : bool|null
Return values
bool|null —getHasPassword()
Gets has_password
public
getHasPassword() : bool
Return values
bool —getId()
Gets id
public
getId() : string
Return values
string —getImapPassword()
Gets imap_password
public
getImapPassword() : string|null
Return values
string|null —getImapUsername()
Gets imap_username
public
getImapUsername() : string|null
Return values
string|null —getIsFrozen()
Gets is_frozen
public
getIsFrozen() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getOrganization()
Gets organization
public
getOrganization() : string|null
Return values
string|null —getPhoneNumber()
Gets phone_number
public
getPhoneNumber() : string|null
Return values
string|null —getSmtpPassword()
Gets smtp_password
public
getSmtpPassword() : string|null
Return values
string|null —getSmtpUsername()
Gets smtp_username
public
getSmtpUsername() : string|null
Return values
string|null —getSsoProvider()
Gets sso_provider
public
getSsoProvider() : string|null
Return values
string|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> —getUnsubscribed()
Gets unsubscribed
public
getUnsubscribed() : bool|null
Return values
bool|null —getUserType()
Gets user_type
public
getUserType() : string|null
Return values
string|null —getUserTypeAllowableValues()
Gets allowable values of the enum
public
getUserTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getVendorEmailAddress()
Gets vendor_email_address
public
getVendorEmailAddress() : string|null
Return values
string|null —getVerified()
Gets verified
public
getVerified() : string|null
Return values
string|null —getVerifiedAllowableValues()
Gets allowable values of the enum
public
getVerifiedAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getVerifiedPhone()
Gets verified_phone
public
getVerifiedPhone() : string|null
Return values
string|null —getVerifiedPhoneAllowableValues()
Gets allowable values of the enum
public
getVerifiedPhoneAllowableValues() : array<string|int, string>
Return values
array<string|int, 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> —setAccessLinkSendResult()
Sets access_link_send_result
public
setAccessLinkSendResult(UserDtoAccessLinkSendResult|null $access_link_send_result) : self
Parameters
- $access_link_send_result : UserDtoAccessLinkSendResult|null
-
access_link_send_result
Return values
self —setAccountRegion()
Sets account_region
public
setAccountRegion(string|null $account_region) : self
Parameters
- $account_region : string|null
-
Default account region
Return values
self —setAddNewContacts()
Sets add_new_contacts
public
setAddNewContacts(bool|null $add_new_contacts) : self
Parameters
- $add_new_contacts : bool|null
-
add_new_contacts
Return values
self —setApiAccessToken()
Sets api_access_token
public
setApiAccessToken(UserDtoApiAccessToken|null $api_access_token) : self
Parameters
- $api_access_token : UserDtoApiAccessToken|null
-
api_access_token
Return values
self —setApiKey()
Sets api_key
public
setApiKey(string $api_key) : self
Parameters
- $api_key : string
-
Deprecate api key use entity instead
Tags
Return values
self —setChargePending()
Sets charge_pending
public
setChargePending(bool|null $charge_pending) : self
Parameters
- $charge_pending : bool|null
-
charge_pending
Return values
self —setCreated()
Sets created
public
setCreated(DateTime|null $created) : self
Parameters
- $created : DateTime|null
-
created
Return values
self —setCustomerId()
Sets customer_id
public
setCustomerId(string|null $customer_id) : self
Parameters
- $customer_id : string|null
-
customer_id
Return values
self —setEmailAddress()
Sets email_address
public
setEmailAddress(string $email_address) : self
Parameters
- $email_address : string
-
email_address
Return values
self —setEmailAddressMd5()
Sets email_address_md5
public
setEmailAddressMd5(string $email_address_md5) : self
Parameters
- $email_address_md5 : string
-
email_address_md5
Return values
self —setEnableSms()
Sets enable_sms
public
setEnableSms(bool|null $enable_sms) : self
Parameters
- $enable_sms : bool|null
-
enable_sms
Return values
self —setFrozenMessage()
Sets frozen_message
public
setFrozenMessage(string|null $frozen_message) : self
Parameters
- $frozen_message : string|null
-
frozen_message
Return values
self —setHasOnboarded()
Sets has_onboarded
public
setHasOnboarded(bool|null $has_onboarded) : self
Parameters
- $has_onboarded : bool|null
-
has_onboarded
Return values
self —setHasPassword()
Sets has_password
public
setHasPassword(bool $has_password) : self
Parameters
- $has_password : bool
-
has_password
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setImapPassword()
Sets imap_password
public
setImapPassword(string|null $imap_password) : self
Parameters
- $imap_password : string|null
-
imap_password
Return values
self —setImapUsername()
Sets imap_username
public
setImapUsername(string|null $imap_username) : self
Parameters
- $imap_username : string|null
-
imap_username
Return values
self —setIsFrozen()
Sets is_frozen
public
setIsFrozen(bool $is_frozen) : self
Parameters
- $is_frozen : bool
-
is_frozen
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
User display name
Return values
self —setOrganization()
Sets organization
public
setOrganization(string|null $organization) : self
Parameters
- $organization : string|null
-
Does user belong to an organization
Return values
self —setPhoneNumber()
Sets phone_number
public
setPhoneNumber(string|null $phone_number) : self
Parameters
- $phone_number : string|null
-
phone_number
Return values
self —setSmtpPassword()
Sets smtp_password
public
setSmtpPassword(string|null $smtp_password) : self
Parameters
- $smtp_password : string|null
-
smtp_password
Return values
self —setSmtpUsername()
Sets smtp_username
public
setSmtpUsername(string|null $smtp_username) : self
Parameters
- $smtp_username : string|null
-
smtp_username
Return values
self —setSsoProvider()
Sets sso_provider
public
setSsoProvider(string|null $sso_provider) : self
Parameters
- $sso_provider : string|null
-
sso_provider
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> —setUnsubscribed()
Sets unsubscribed
public
setUnsubscribed(bool|null $unsubscribed) : self
Parameters
- $unsubscribed : bool|null
-
unsubscribed
Return values
self —setUserType()
Sets user_type
public
setUserType(string|null $user_type) : self
Parameters
- $user_type : string|null
-
user_type
Return values
self —setVendorEmailAddress()
Sets vendor_email_address
public
setVendorEmailAddress(string|null $vendor_email_address) : self
Parameters
- $vendor_email_address : string|null
-
vendor_email_address
Return values
self —setVerified()
Sets verified
public
setVerified(string|null $verified) : self
Parameters
- $verified : string|null
-
Has user accepted an organization invite
Return values
self —setVerifiedPhone()
Sets verified_phone
public
setVerifiedPhone(string|null $verified_phone) : self
Parameters
- $verified_phone : string|null
-
Has user accepted an organization invite
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>