AccountDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AccountDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- ADDONS_AI = 'AI'
- ADDONS_CONNECTORS = 'CONNECTORS'
- ADDONS_DEVICE_RENDER = 'DEVICE_RENDER'
- ADDONS_DOMAIN_MONITOR = 'DOMAIN_MONITOR'
- ADDONS_EMAILS = 'EMAILS'
- ADDONS_GUEST = 'GUEST'
- ADDONS_INBOX_PLACEMENT_TESTS = 'INBOX_PLACEMENT_TESTS'
- ADDONS_INBOXES = 'INBOXES'
- ADDONS_STORAGE = 'STORAGE'
- ADDONS_VALIDATION = 'VALIDATION'
- ADDONS_WARMUP_SENDERS = 'WARMUP_SENDERS'
- ADDONS_WARMUP_USAGE = 'WARMUP_USAGE'
- DEFAULT_CURRENCY_AUD = 'AUD'
- DEFAULT_CURRENCY_CAD = 'CAD'
- DEFAULT_CURRENCY_CHF = 'CHF'
- DEFAULT_CURRENCY_CNY = 'CNY'
- DEFAULT_CURRENCY_EUR = 'EUR'
- DEFAULT_CURRENCY_GBP = 'GBP'
- DEFAULT_CURRENCY_INR = 'INR'
- DEFAULT_CURRENCY_JPY = 'JPY'
- DEFAULT_CURRENCY_NZD = 'NZD'
- DEFAULT_CURRENCY_USD = 'USD'
- DEFAULT_SCHEDULE_MONTHLY = 'MONTHLY'
- DEFAULT_SCHEDULE_YEARLY = 'YEARLY'
- DISCRIMINATOR = null
- FREE_ACCOUNT_EVALUATION_DENIED_REASON_COUNTRY = 'COUNTRY'
- FREE_ACCOUNT_EVALUATION_DENIED_REASON_DOMAIN = 'DOMAIN'
- FREE_ACCOUNT_EVALUATION_DENIED_REASON_FREE_EMAIL_PROVIDER = 'FREE_EMAIL_PROVIDER'
- FREE_ACCOUNT_MODE_LEGACY_EVALUATION = 'LEGACY_EVALUATION'
- FREE_ACCOUNT_MODE_NONE = 'NONE'
- FREE_ACCOUNT_MODE_PERMANENT_SANDBOX = 'PERMANENT_SANDBOX'
- REQUIRED_VERIFICATION_TYPES_EMAIL_ADDRESS = 'EMAIL_ADDRESS'
- REQUIRED_VERIFICATION_TYPES_PHONE_NUMBER = 'PHONE_NUMBER'
- $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
- getAddons() : array<string|int, string>|null
- Gets addons
- getAddonsAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getAdminSendPause() : AccountDtoAdminSendPause|null
- Gets admin_send_pause
- getAssignedDomainCount() : int
- Gets assigned_domain_count
- getCanEndTrial() : bool
- Gets can_end_trial
- getChurnkeyHash() : string|null
- Gets churnkey_hash
- getCurrentPeriod() : CurrentPeriodDto
- Gets current_period
- getDefaultCurrency() : string
- Gets default_currency
- getDefaultCurrencyAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getDefaultSchedule() : string
- Gets default_schedule
- getDefaultScheduleAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getDomainPlanQuantity() : int
- Gets domain_plan_quantity
- getEffectiveDomainLimit() : int|null
- Gets effective_domain_limit
- getEnforceSendingAgreement() : bool
- Gets enforce_sending_agreement
- getEnvironmentAccounts() : AccountDtoEnvironmentAccounts|null
- Gets environment_accounts
- getFreeAccountEvaluationDenied() : bool
- Gets free_account_evaluation_denied
- getFreeAccountEvaluationDeniedAllowTrial() : bool
- Gets free_account_evaluation_denied_allow_trial
- getFreeAccountEvaluationDeniedReason() : string|null
- Gets free_account_evaluation_denied_reason
- getFreeAccountEvaluationDeniedReasonAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getFreeAccountExpired() : bool
- Gets free_account_expired
- getFreeAccountExpiresInDays() : int|null
- Gets free_account_expires_in_days
- getFreeAccountMode() : string
- Gets free_account_mode
- getFreeAccountModeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getHasAnyActiveTrialSubscription() : bool
- Gets has_any_active_trial_subscription
- getHasBadSubscriptionItemStatuses() : bool|null
- Gets has_bad_subscription_item_statuses
- getIntercomHash() : string|null
- Gets intercom_hash
- getModelName() : string
- The original name of the model.
- getOrganizationBrandColor() : string|null
- Gets organization_brand_color
- getOrganizationLogoUrl() : string|null
- Gets organization_logo_url
- getOrganizationName() : string|null
- Gets organization_name
- getOrganizationSlug() : string|null
- Gets organization_slug
- getRequiredVerificationTypes() : array<string|int, string>|null
- Gets required_verification_types
- getRequiredVerificationTypesAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getRequiresDashboardOnboardingV2() : bool
- Gets requires_dashboard_onboarding_v2
- getRequiresTermsAndConditionsAgreement() : bool|null
- Gets requires_terms_and_conditions_agreement
- getRequiresVerification() : bool
- Gets requires_verification
- getSubscription() : AccountDtoSubscription|null
- Gets subscription
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTrialsEnabled() : bool
- Gets trials_enabled
- getUser() : UserDto
- Gets user
- getUserPermissionRole() : string|null
- Gets user_permission_role
- 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
- setAddons() : self
- Sets addons
- setAdminSendPause() : self
- Sets admin_send_pause
- setAssignedDomainCount() : self
- Sets assigned_domain_count
- setCanEndTrial() : self
- Sets can_end_trial
- setChurnkeyHash() : self
- Sets churnkey_hash
- setCurrentPeriod() : self
- Sets current_period
- setDefaultCurrency() : self
- Sets default_currency
- setDefaultSchedule() : self
- Sets default_schedule
- setDomainPlanQuantity() : self
- Sets domain_plan_quantity
- setEffectiveDomainLimit() : self
- Sets effective_domain_limit
- setEnforceSendingAgreement() : self
- Sets enforce_sending_agreement
- setEnvironmentAccounts() : self
- Sets environment_accounts
- setFreeAccountEvaluationDenied() : self
- Sets free_account_evaluation_denied
- setFreeAccountEvaluationDeniedAllowTrial() : self
- Sets free_account_evaluation_denied_allow_trial
- setFreeAccountEvaluationDeniedReason() : self
- Sets free_account_evaluation_denied_reason
- setFreeAccountExpired() : self
- Sets free_account_expired
- setFreeAccountExpiresInDays() : self
- Sets free_account_expires_in_days
- setFreeAccountMode() : self
- Sets free_account_mode
- setHasAnyActiveTrialSubscription() : self
- Sets has_any_active_trial_subscription
- setHasBadSubscriptionItemStatuses() : self
- Sets has_bad_subscription_item_statuses
- setIntercomHash() : self
- Sets intercom_hash
- setOrganizationBrandColor() : self
- Sets organization_brand_color
- setOrganizationLogoUrl() : self
- Sets organization_logo_url
- setOrganizationName() : self
- Sets organization_name
- setOrganizationSlug() : self
- Sets organization_slug
- setRequiredVerificationTypes() : self
- Sets required_verification_types
- setRequiresDashboardOnboardingV2() : self
- Sets requires_dashboard_onboarding_v2
- setRequiresTermsAndConditionsAgreement() : self
- Sets requires_terms_and_conditions_agreement
- setRequiresVerification() : self
- Sets requires_verification
- setSubscription() : self
- Sets subscription
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTrialsEnabled() : self
- Sets trials_enabled
- setUser() : self
- Sets user
- setUserPermissionRole() : self
- Sets user_permission_role
- 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
ADDONS_AI
public
mixed
ADDONS_AI
= 'AI'
ADDONS_CONNECTORS
public
mixed
ADDONS_CONNECTORS
= 'CONNECTORS'
ADDONS_DEVICE_RENDER
public
mixed
ADDONS_DEVICE_RENDER
= 'DEVICE_RENDER'
ADDONS_DOMAIN_MONITOR
public
mixed
ADDONS_DOMAIN_MONITOR
= 'DOMAIN_MONITOR'
ADDONS_EMAILS
public
mixed
ADDONS_EMAILS
= 'EMAILS'
ADDONS_GUEST
public
mixed
ADDONS_GUEST
= 'GUEST'
ADDONS_INBOX_PLACEMENT_TESTS
public
mixed
ADDONS_INBOX_PLACEMENT_TESTS
= 'INBOX_PLACEMENT_TESTS'
ADDONS_INBOXES
public
mixed
ADDONS_INBOXES
= 'INBOXES'
ADDONS_STORAGE
public
mixed
ADDONS_STORAGE
= 'STORAGE'
ADDONS_VALIDATION
public
mixed
ADDONS_VALIDATION
= 'VALIDATION'
ADDONS_WARMUP_SENDERS
public
mixed
ADDONS_WARMUP_SENDERS
= 'WARMUP_SENDERS'
ADDONS_WARMUP_USAGE
public
mixed
ADDONS_WARMUP_USAGE
= 'WARMUP_USAGE'
DEFAULT_CURRENCY_AUD
public
mixed
DEFAULT_CURRENCY_AUD
= 'AUD'
DEFAULT_CURRENCY_CAD
public
mixed
DEFAULT_CURRENCY_CAD
= 'CAD'
DEFAULT_CURRENCY_CHF
public
mixed
DEFAULT_CURRENCY_CHF
= 'CHF'
DEFAULT_CURRENCY_CNY
public
mixed
DEFAULT_CURRENCY_CNY
= 'CNY'
DEFAULT_CURRENCY_EUR
public
mixed
DEFAULT_CURRENCY_EUR
= 'EUR'
DEFAULT_CURRENCY_GBP
public
mixed
DEFAULT_CURRENCY_GBP
= 'GBP'
DEFAULT_CURRENCY_INR
public
mixed
DEFAULT_CURRENCY_INR
= 'INR'
DEFAULT_CURRENCY_JPY
public
mixed
DEFAULT_CURRENCY_JPY
= 'JPY'
DEFAULT_CURRENCY_NZD
public
mixed
DEFAULT_CURRENCY_NZD
= 'NZD'
DEFAULT_CURRENCY_USD
public
mixed
DEFAULT_CURRENCY_USD
= 'USD'
DEFAULT_SCHEDULE_MONTHLY
public
mixed
DEFAULT_SCHEDULE_MONTHLY
= 'MONTHLY'
DEFAULT_SCHEDULE_YEARLY
public
mixed
DEFAULT_SCHEDULE_YEARLY
= 'YEARLY'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
FREE_ACCOUNT_EVALUATION_DENIED_REASON_COUNTRY
public
mixed
FREE_ACCOUNT_EVALUATION_DENIED_REASON_COUNTRY
= 'COUNTRY'
FREE_ACCOUNT_EVALUATION_DENIED_REASON_DOMAIN
public
mixed
FREE_ACCOUNT_EVALUATION_DENIED_REASON_DOMAIN
= 'DOMAIN'
FREE_ACCOUNT_EVALUATION_DENIED_REASON_FREE_EMAIL_PROVIDER
public
mixed
FREE_ACCOUNT_EVALUATION_DENIED_REASON_FREE_EMAIL_PROVIDER
= 'FREE_EMAIL_PROVIDER'
FREE_ACCOUNT_MODE_LEGACY_EVALUATION
public
mixed
FREE_ACCOUNT_MODE_LEGACY_EVALUATION
= 'LEGACY_EVALUATION'
FREE_ACCOUNT_MODE_NONE
public
mixed
FREE_ACCOUNT_MODE_NONE
= 'NONE'
FREE_ACCOUNT_MODE_PERMANENT_SANDBOX
public
mixed
FREE_ACCOUNT_MODE_PERMANENT_SANDBOX
= 'PERMANENT_SANDBOX'
REQUIRED_VERIFICATION_TYPES_EMAIL_ADDRESS
public
mixed
REQUIRED_VERIFICATION_TYPES_EMAIL_ADDRESS
= 'EMAIL_ADDRESS'
REQUIRED_VERIFICATION_TYPES_PHONE_NUMBER
public
mixed
REQUIRED_VERIFICATION_TYPES_PHONE_NUMBER
= 'PHONE_NUMBER'
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
= ['user' => 'user', 'subscription' => 'subscription', 'addons' => 'addons', 'intercom_hash' => 'intercomHash', 'churnkey_hash' => 'churnkeyHash', 'current_period' => 'currentPeriod', 'requires_verification' => 'requiresVerification', 'required_verification_types' => 'requiredVerificationTypes', 'default_currency' => 'defaultCurrency', 'default_schedule' => 'defaultSchedule', 'has_bad_subscription_item_statuses' => 'hasBadSubscriptionItemStatuses', 'trials_enabled' => 'trialsEnabled', 'has_any_active_trial_subscription' => 'hasAnyActiveTrialSubscription', 'can_end_trial' => 'canEndTrial', 'free_account_expires_in_days' => 'freeAccountExpiresInDays', 'free_account_expired' => 'freeAccountExpired', 'free_account_evaluation_denied' => 'freeAccountEvaluationDenied', 'free_account_evaluation_denied_reason' => 'freeAccountEvaluationDeniedReason', 'free_account_evaluation_denied_allow_trial' => 'freeAccountEvaluationDeniedAllowTrial', 'free_account_mode' => 'freeAccountMode', 'requires_terms_and_conditions_agreement' => 'requiresTermsAndConditionsAgreement', 'enforce_sending_agreement' => 'enforceSendingAgreement', 'admin_send_pause' => 'adminSendPause', 'organization_name' => 'organizationName', 'organization_slug' => 'organizationSlug', 'organization_brand_color' => 'organizationBrandColor', 'organization_logo_url' => 'organizationLogoUrl', 'user_permission_role' => 'userPermissionRole', 'environment_accounts' => 'environmentAccounts', 'domain_plan_quantity' => 'domainPlanQuantity', 'assigned_domain_count' => 'assignedDomainCount', 'effective_domain_limit' => 'effectiveDomainLimit', 'requires_dashboard_onboarding_v2' => 'requiresDashboardOnboardingV2']
$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
= ['user' => 'getUser', 'subscription' => 'getSubscription', 'addons' => 'getAddons', 'intercom_hash' => 'getIntercomHash', 'churnkey_hash' => 'getChurnkeyHash', 'current_period' => 'getCurrentPeriod', 'requires_verification' => 'getRequiresVerification', 'required_verification_types' => 'getRequiredVerificationTypes', 'default_currency' => 'getDefaultCurrency', 'default_schedule' => 'getDefaultSchedule', 'has_bad_subscription_item_statuses' => 'getHasBadSubscriptionItemStatuses', 'trials_enabled' => 'getTrialsEnabled', 'has_any_active_trial_subscription' => 'getHasAnyActiveTrialSubscription', 'can_end_trial' => 'getCanEndTrial', 'free_account_expires_in_days' => 'getFreeAccountExpiresInDays', 'free_account_expired' => 'getFreeAccountExpired', 'free_account_evaluation_denied' => 'getFreeAccountEvaluationDenied', 'free_account_evaluation_denied_reason' => 'getFreeAccountEvaluationDeniedReason', 'free_account_evaluation_denied_allow_trial' => 'getFreeAccountEvaluationDeniedAllowTrial', 'free_account_mode' => 'getFreeAccountMode', 'requires_terms_and_conditions_agreement' => 'getRequiresTermsAndConditionsAgreement', 'enforce_sending_agreement' => 'getEnforceSendingAgreement', 'admin_send_pause' => 'getAdminSendPause', 'organization_name' => 'getOrganizationName', 'organization_slug' => 'getOrganizationSlug', 'organization_brand_color' => 'getOrganizationBrandColor', 'organization_logo_url' => 'getOrganizationLogoUrl', 'user_permission_role' => 'getUserPermissionRole', 'environment_accounts' => 'getEnvironmentAccounts', 'domain_plan_quantity' => 'getDomainPlanQuantity', 'assigned_domain_count' => 'getAssignedDomainCount', 'effective_domain_limit' => 'getEffectiveDomainLimit', 'requires_dashboard_onboarding_v2' => 'getRequiresDashboardOnboardingV2']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['user' => null, 'subscription' => null, 'addons' => null, 'intercom_hash' => null, 'churnkey_hash' => null, 'current_period' => null, 'requires_verification' => null, 'required_verification_types' => null, 'default_currency' => null, 'default_schedule' => null, 'has_bad_subscription_item_statuses' => null, 'trials_enabled' => null, 'has_any_active_trial_subscription' => null, 'can_end_trial' => null, 'free_account_expires_in_days' => 'int32', 'free_account_expired' => null, 'free_account_evaluation_denied' => null, 'free_account_evaluation_denied_reason' => null, 'free_account_evaluation_denied_allow_trial' => null, 'free_account_mode' => null, 'requires_terms_and_conditions_agreement' => null, 'enforce_sending_agreement' => null, 'admin_send_pause' => null, 'organization_name' => null, 'organization_slug' => null, 'organization_brand_color' => null, 'organization_logo_url' => null, 'user_permission_role' => null, 'environment_accounts' => null, 'domain_plan_quantity' => 'int32', 'assigned_domain_count' => 'int32', 'effective_domain_limit' => 'int32', 'requires_dashboard_onboarding_v2' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AccountDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['user' => false, 'subscription' => true, 'addons' => true, 'intercom_hash' => true, 'churnkey_hash' => true, 'current_period' => false, 'requires_verification' => false, 'required_verification_types' => true, 'default_currency' => false, 'default_schedule' => false, 'has_bad_subscription_item_statuses' => true, 'trials_enabled' => false, 'has_any_active_trial_subscription' => false, 'can_end_trial' => false, 'free_account_expires_in_days' => true, 'free_account_expired' => false, 'free_account_evaluation_denied' => false, 'free_account_evaluation_denied_reason' => true, 'free_account_evaluation_denied_allow_trial' => false, 'free_account_mode' => false, 'requires_terms_and_conditions_agreement' => true, 'enforce_sending_agreement' => false, 'admin_send_pause' => true, 'organization_name' => true, 'organization_slug' => true, 'organization_brand_color' => true, 'organization_logo_url' => true, 'user_permission_role' => true, 'environment_accounts' => true, 'domain_plan_quantity' => false, 'assigned_domain_count' => false, 'effective_domain_limit' => true, 'requires_dashboard_onboarding_v2' => 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
= ['user' => '\\MailSlurp\\Models\\UserDto', 'subscription' => '\\MailSlurp\\Models\\AccountDtoSubscription', 'addons' => 'string[]', 'intercom_hash' => 'string', 'churnkey_hash' => 'string', 'current_period' => '\\MailSlurp\\Models\\CurrentPeriodDto', 'requires_verification' => 'bool', 'required_verification_types' => 'string[]', 'default_currency' => 'string', 'default_schedule' => 'string', 'has_bad_subscription_item_statuses' => 'bool', 'trials_enabled' => 'bool', 'has_any_active_trial_subscription' => 'bool', 'can_end_trial' => 'bool', 'free_account_expires_in_days' => 'int', 'free_account_expired' => 'bool', 'free_account_evaluation_denied' => 'bool', 'free_account_evaluation_denied_reason' => 'string', 'free_account_evaluation_denied_allow_trial' => 'bool', 'free_account_mode' => 'string', 'requires_terms_and_conditions_agreement' => 'bool', 'enforce_sending_agreement' => 'bool', 'admin_send_pause' => '\\MailSlurp\\Models\\AccountDtoAdminSendPause', 'organization_name' => 'string', 'organization_slug' => 'string', 'organization_brand_color' => 'string', 'organization_logo_url' => 'string', 'user_permission_role' => 'string', 'environment_accounts' => '\\MailSlurp\\Models\\AccountDtoEnvironmentAccounts', 'domain_plan_quantity' => 'int', 'assigned_domain_count' => 'int', 'effective_domain_limit' => 'int', 'requires_dashboard_onboarding_v2' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['user' => 'setUser', 'subscription' => 'setSubscription', 'addons' => 'setAddons', 'intercom_hash' => 'setIntercomHash', 'churnkey_hash' => 'setChurnkeyHash', 'current_period' => 'setCurrentPeriod', 'requires_verification' => 'setRequiresVerification', 'required_verification_types' => 'setRequiredVerificationTypes', 'default_currency' => 'setDefaultCurrency', 'default_schedule' => 'setDefaultSchedule', 'has_bad_subscription_item_statuses' => 'setHasBadSubscriptionItemStatuses', 'trials_enabled' => 'setTrialsEnabled', 'has_any_active_trial_subscription' => 'setHasAnyActiveTrialSubscription', 'can_end_trial' => 'setCanEndTrial', 'free_account_expires_in_days' => 'setFreeAccountExpiresInDays', 'free_account_expired' => 'setFreeAccountExpired', 'free_account_evaluation_denied' => 'setFreeAccountEvaluationDenied', 'free_account_evaluation_denied_reason' => 'setFreeAccountEvaluationDeniedReason', 'free_account_evaluation_denied_allow_trial' => 'setFreeAccountEvaluationDeniedAllowTrial', 'free_account_mode' => 'setFreeAccountMode', 'requires_terms_and_conditions_agreement' => 'setRequiresTermsAndConditionsAgreement', 'enforce_sending_agreement' => 'setEnforceSendingAgreement', 'admin_send_pause' => 'setAdminSendPause', 'organization_name' => 'setOrganizationName', 'organization_slug' => 'setOrganizationSlug', 'organization_brand_color' => 'setOrganizationBrandColor', 'organization_logo_url' => 'setOrganizationLogoUrl', 'user_permission_role' => 'setUserPermissionRole', 'environment_accounts' => 'setEnvironmentAccounts', 'domain_plan_quantity' => 'setDomainPlanQuantity', 'assigned_domain_count' => 'setAssignedDomainCount', 'effective_domain_limit' => 'setEffectiveDomainLimit', 'requires_dashboard_onboarding_v2' => 'setRequiresDashboardOnboardingV2']
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> —getAddons()
Gets addons
public
getAddons() : array<string|int, string>|null
Return values
array<string|int, string>|null —getAddonsAllowableValues()
Gets allowable values of the enum
public
getAddonsAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getAdminSendPause()
Gets admin_send_pause
public
getAdminSendPause() : AccountDtoAdminSendPause|null
Return values
AccountDtoAdminSendPause|null —getAssignedDomainCount()
Gets assigned_domain_count
public
getAssignedDomainCount() : int
Return values
int —getCanEndTrial()
Gets can_end_trial
public
getCanEndTrial() : bool
Return values
bool —getChurnkeyHash()
Gets churnkey_hash
public
getChurnkeyHash() : string|null
Tags
Return values
string|null —getCurrentPeriod()
Gets current_period
public
getCurrentPeriod() : CurrentPeriodDto
Return values
CurrentPeriodDto —getDefaultCurrency()
Gets default_currency
public
getDefaultCurrency() : string
Return values
string —getDefaultCurrencyAllowableValues()
Gets allowable values of the enum
public
getDefaultCurrencyAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getDefaultSchedule()
Gets default_schedule
public
getDefaultSchedule() : string
Return values
string —getDefaultScheduleAllowableValues()
Gets allowable values of the enum
public
getDefaultScheduleAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getDomainPlanQuantity()
Gets domain_plan_quantity
public
getDomainPlanQuantity() : int
Return values
int —getEffectiveDomainLimit()
Gets effective_domain_limit
public
getEffectiveDomainLimit() : int|null
Return values
int|null —getEnforceSendingAgreement()
Gets enforce_sending_agreement
public
getEnforceSendingAgreement() : bool
Return values
bool —getEnvironmentAccounts()
Gets environment_accounts
public
getEnvironmentAccounts() : AccountDtoEnvironmentAccounts|null
Return values
AccountDtoEnvironmentAccounts|null —getFreeAccountEvaluationDenied()
Gets free_account_evaluation_denied
public
getFreeAccountEvaluationDenied() : bool
Return values
bool —getFreeAccountEvaluationDeniedAllowTrial()
Gets free_account_evaluation_denied_allow_trial
public
getFreeAccountEvaluationDeniedAllowTrial() : bool
Return values
bool —getFreeAccountEvaluationDeniedReason()
Gets free_account_evaluation_denied_reason
public
getFreeAccountEvaluationDeniedReason() : string|null
Return values
string|null —getFreeAccountEvaluationDeniedReasonAllowableValues()
Gets allowable values of the enum
public
getFreeAccountEvaluationDeniedReasonAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getFreeAccountExpired()
Gets free_account_expired
public
getFreeAccountExpired() : bool
Return values
bool —getFreeAccountExpiresInDays()
Gets free_account_expires_in_days
public
getFreeAccountExpiresInDays() : int|null
Return values
int|null —getFreeAccountMode()
Gets free_account_mode
public
getFreeAccountMode() : string
Return values
string —getFreeAccountModeAllowableValues()
Gets allowable values of the enum
public
getFreeAccountModeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getHasAnyActiveTrialSubscription()
Gets has_any_active_trial_subscription
public
getHasAnyActiveTrialSubscription() : bool
Return values
bool —getHasBadSubscriptionItemStatuses()
Gets has_bad_subscription_item_statuses
public
getHasBadSubscriptionItemStatuses() : bool|null
Return values
bool|null —getIntercomHash()
Gets intercom_hash
public
getIntercomHash() : string|null
Tags
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOrganizationBrandColor()
Gets organization_brand_color
public
getOrganizationBrandColor() : string|null
Return values
string|null —getOrganizationLogoUrl()
Gets organization_logo_url
public
getOrganizationLogoUrl() : string|null
Return values
string|null —getOrganizationName()
Gets organization_name
public
getOrganizationName() : string|null
Return values
string|null —getOrganizationSlug()
Gets organization_slug
public
getOrganizationSlug() : string|null
Return values
string|null —getRequiredVerificationTypes()
Gets required_verification_types
public
getRequiredVerificationTypes() : array<string|int, string>|null
Return values
array<string|int, string>|null —getRequiredVerificationTypesAllowableValues()
Gets allowable values of the enum
public
getRequiredVerificationTypesAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getRequiresDashboardOnboardingV2()
Gets requires_dashboard_onboarding_v2
public
getRequiresDashboardOnboardingV2() : bool
Return values
bool —getRequiresTermsAndConditionsAgreement()
Gets requires_terms_and_conditions_agreement
public
getRequiresTermsAndConditionsAgreement() : bool|null
Return values
bool|null —getRequiresVerification()
Gets requires_verification
public
getRequiresVerification() : bool
Return values
bool —getSubscription()
Gets subscription
public
getSubscription() : AccountDtoSubscription|null
Return values
AccountDtoSubscription|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> —getTrialsEnabled()
Gets trials_enabled
public
getTrialsEnabled() : bool
Return values
bool —getUser()
Gets user
public
getUser() : UserDto
Return values
UserDto —getUserPermissionRole()
Gets user_permission_role
public
getUserPermissionRole() : string|null
Return values
string|null —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —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> —setAddons()
Sets addons
public
setAddons(array<string|int, string>|null $addons) : self
Parameters
- $addons : array<string|int, string>|null
-
addons
Return values
self —setAdminSendPause()
Sets admin_send_pause
public
setAdminSendPause(AccountDtoAdminSendPause|null $admin_send_pause) : self
Parameters
- $admin_send_pause : AccountDtoAdminSendPause|null
-
admin_send_pause
Return values
self —setAssignedDomainCount()
Sets assigned_domain_count
public
setAssignedDomainCount(int $assigned_domain_count) : self
Parameters
- $assigned_domain_count : int
-
assigned_domain_count
Return values
self —setCanEndTrial()
Sets can_end_trial
public
setCanEndTrial(bool $can_end_trial) : self
Parameters
- $can_end_trial : bool
-
can_end_trial
Return values
self —setChurnkeyHash()
Sets churnkey_hash
public
setChurnkeyHash(string|null $churnkey_hash) : self
Parameters
- $churnkey_hash : string|null
-
disabled
Tags
Return values
self —setCurrentPeriod()
Sets current_period
public
setCurrentPeriod(CurrentPeriodDto $current_period) : self
Parameters
- $current_period : CurrentPeriodDto
-
current_period
Return values
self —setDefaultCurrency()
Sets default_currency
public
setDefaultCurrency(string $default_currency) : self
Parameters
- $default_currency : string
-
default_currency
Return values
self —setDefaultSchedule()
Sets default_schedule
public
setDefaultSchedule(string $default_schedule) : self
Parameters
- $default_schedule : string
-
default_schedule
Return values
self —setDomainPlanQuantity()
Sets domain_plan_quantity
public
setDomainPlanQuantity(int $domain_plan_quantity) : self
Parameters
- $domain_plan_quantity : int
-
domain_plan_quantity
Return values
self —setEffectiveDomainLimit()
Sets effective_domain_limit
public
setEffectiveDomainLimit(int|null $effective_domain_limit) : self
Parameters
- $effective_domain_limit : int|null
-
effective_domain_limit
Return values
self —setEnforceSendingAgreement()
Sets enforce_sending_agreement
public
setEnforceSendingAgreement(bool $enforce_sending_agreement) : self
Parameters
- $enforce_sending_agreement : bool
-
enforce_sending_agreement
Return values
self —setEnvironmentAccounts()
Sets environment_accounts
public
setEnvironmentAccounts(AccountDtoEnvironmentAccounts|null $environment_accounts) : self
Parameters
- $environment_accounts : AccountDtoEnvironmentAccounts|null
-
environment_accounts
Return values
self —setFreeAccountEvaluationDenied()
Sets free_account_evaluation_denied
public
setFreeAccountEvaluationDenied(bool $free_account_evaluation_denied) : self
Parameters
- $free_account_evaluation_denied : bool
-
free_account_evaluation_denied
Return values
self —setFreeAccountEvaluationDeniedAllowTrial()
Sets free_account_evaluation_denied_allow_trial
public
setFreeAccountEvaluationDeniedAllowTrial(bool $free_account_evaluation_denied_allow_trial) : self
Parameters
- $free_account_evaluation_denied_allow_trial : bool
-
free_account_evaluation_denied_allow_trial
Return values
self —setFreeAccountEvaluationDeniedReason()
Sets free_account_evaluation_denied_reason
public
setFreeAccountEvaluationDeniedReason(string|null $free_account_evaluation_denied_reason) : self
Parameters
- $free_account_evaluation_denied_reason : string|null
-
free_account_evaluation_denied_reason
Return values
self —setFreeAccountExpired()
Sets free_account_expired
public
setFreeAccountExpired(bool $free_account_expired) : self
Parameters
- $free_account_expired : bool
-
free_account_expired
Return values
self —setFreeAccountExpiresInDays()
Sets free_account_expires_in_days
public
setFreeAccountExpiresInDays(int|null $free_account_expires_in_days) : self
Parameters
- $free_account_expires_in_days : int|null
-
free_account_expires_in_days
Return values
self —setFreeAccountMode()
Sets free_account_mode
public
setFreeAccountMode(string $free_account_mode) : self
Parameters
- $free_account_mode : string
-
free_account_mode
Return values
self —setHasAnyActiveTrialSubscription()
Sets has_any_active_trial_subscription
public
setHasAnyActiveTrialSubscription(bool $has_any_active_trial_subscription) : self
Parameters
- $has_any_active_trial_subscription : bool
-
has_any_active_trial_subscription
Return values
self —setHasBadSubscriptionItemStatuses()
Sets has_bad_subscription_item_statuses
public
setHasBadSubscriptionItemStatuses(bool|null $has_bad_subscription_item_statuses) : self
Parameters
- $has_bad_subscription_item_statuses : bool|null
-
has_bad_subscription_item_statuses
Return values
self —setIntercomHash()
Sets intercom_hash
public
setIntercomHash(string|null $intercom_hash) : self
Parameters
- $intercom_hash : string|null
-
disabled
Tags
Return values
self —setOrganizationBrandColor()
Sets organization_brand_color
public
setOrganizationBrandColor(string|null $organization_brand_color) : self
Parameters
- $organization_brand_color : string|null
-
organization_brand_color
Return values
self —setOrganizationLogoUrl()
Sets organization_logo_url
public
setOrganizationLogoUrl(string|null $organization_logo_url) : self
Parameters
- $organization_logo_url : string|null
-
organization_logo_url
Return values
self —setOrganizationName()
Sets organization_name
public
setOrganizationName(string|null $organization_name) : self
Parameters
- $organization_name : string|null
-
organization_name
Return values
self —setOrganizationSlug()
Sets organization_slug
public
setOrganizationSlug(string|null $organization_slug) : self
Parameters
- $organization_slug : string|null
-
organization_slug
Return values
self —setRequiredVerificationTypes()
Sets required_verification_types
public
setRequiredVerificationTypes(array<string|int, string>|null $required_verification_types) : self
Parameters
- $required_verification_types : array<string|int, string>|null
-
required_verification_types
Return values
self —setRequiresDashboardOnboardingV2()
Sets requires_dashboard_onboarding_v2
public
setRequiresDashboardOnboardingV2(bool $requires_dashboard_onboarding_v2) : self
Parameters
- $requires_dashboard_onboarding_v2 : bool
-
requires_dashboard_onboarding_v2
Return values
self —setRequiresTermsAndConditionsAgreement()
Sets requires_terms_and_conditions_agreement
public
setRequiresTermsAndConditionsAgreement(bool|null $requires_terms_and_conditions_agreement) : self
Parameters
- $requires_terms_and_conditions_agreement : bool|null
-
requires_terms_and_conditions_agreement
Return values
self —setRequiresVerification()
Sets requires_verification
public
setRequiresVerification(bool $requires_verification) : self
Parameters
- $requires_verification : bool
-
requires_verification
Return values
self —setSubscription()
Sets subscription
public
setSubscription(AccountDtoSubscription|null $subscription) : self
Parameters
- $subscription : AccountDtoSubscription|null
-
subscription
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> —setTrialsEnabled()
Sets trials_enabled
public
setTrialsEnabled(bool $trials_enabled) : self
Parameters
- $trials_enabled : bool
-
trials_enabled
Return values
self —setUser()
Sets user
public
setUser(UserDto $user) : self
Parameters
- $user : UserDto
-
user
Return values
self —setUserPermissionRole()
Sets user_permission_role
public
setUserPermissionRole(string|null $user_permission_role) : self
Parameters
- $user_permission_role : string|null
-
user_permission_role
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>