Documentation

AccountDtoSubscription
in package

MailSlurp

implements ModelInterface, ArrayAccess, JsonSerializable

AccountDtoSubscription Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

CURRENCY_AUD = 'AUD'
CURRENCY_CAD = 'CAD'
CURRENCY_CHF = 'CHF'
CURRENCY_CNY = 'CNY'
CURRENCY_EUR = 'EUR'
CURRENCY_GBP = 'GBP'
CURRENCY_INR = 'INR'
CURRENCY_JPY = 'JPY'
CURRENCY_NZD = 'NZD'
CURRENCY_USD = 'USD'
DISCRIMINATOR = null
SUBSCRIPTION_SCHEDULE_MONTHLY = 'MONTHLY'
SUBSCRIPTION_SCHEDULE_YEARLY = 'YEARLY'
SUBSCRIPTION_STATUS_ACTIVE = 'active'
SUBSCRIPTION_STATUS_CANCELED = 'canceled'
SUBSCRIPTION_STATUS_INCOMPLETE = 'incomplete'
SUBSCRIPTION_STATUS_INCOMPLETE_EXPIRED = 'incomplete_expired'
SUBSCRIPTION_STATUS_PAST_DUE = 'past_due'
SUBSCRIPTION_STATUS_PAUSED = 'paused'
SUBSCRIPTION_STATUS_TRIALING = 'trialing'
SUBSCRIPTION_STATUS_UNPAID = 'unpaid'
SUBSCRIPTION_TYPE_ENTERPRISE = 'ENTERPRISE'
SUBSCRIPTION_TYPE_PRO = 'PRO'
SUBSCRIPTION_TYPE_PRO_MONTHLY = 'PRO_MONTHLY'
SUBSCRIPTION_TYPE_STARTER = 'STARTER'
SUBSCRIPTION_TYPE_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
getAgents() : int|null: Gets agents
getAiDestinationSheets() : bool: Gets ai_destination_sheets
getAiTransformers() : bool: Gets ai_transformers
getAliases() : int: Gets aliases
getAttachmentAutomations() : bool: Gets attachment_automations
getAttachments() : bool: Gets attachments
getAuditLogs() : bool|null: Gets audit_logs
getBackup() : bool|null: Gets backup
getBulk() : bool: Gets bulk
getCampaignProbe() : bool|null: Gets campaign_probe
getCancelAt() : DateTime|null: Gets cancel_at
getContacts() : bool: Gets contacts
getCost() : int|null: Gets cost
getCostMajor() : float|null: Gets cost_major
getCreatedAt() : DateTime: Gets created_at
getCurrency() : string|null: Gets currency
getCurrencyAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getCurrentPeriodEnd() : DateTime: Gets current_period_end
getCurrentPeriodStart() : DateTime: Gets current_period_start
getCustomerId() : string|null: Gets customer_id
getDailyReceive() : int: Gets daily_receive
getDailySend() : int: Gets daily_send
getDeliverabilityTest() : bool|null: Gets deliverability_test
getDemoDaysRemaining() : int|null: Gets demo_days_remaining
getDevicePreviews() : bool|null: Gets device_previews
getDomainMonitor() : bool|null: Gets domain_monitor
getDomains() : int: Gets domains
getEmailAudit() : bool|null: Gets email_audit
getEmailFeatureCheck() : bool|null: Gets email_feature_check
getEnvironments() : bool|null: Gets environments
getExternalPlanId() : string|null: Gets external_plan_id
getExternalValidationPlanId() : string|null: Gets external_validation_plan_id
getExternalValidationSubscriptionItemId() : string|null: Gets external_validation_subscription_item_id
getGmailInboxConnection() : bool: Gets gmail_inbox_connection
getGmailInboxConnectionLimit() : int: Gets gmail_inbox_connection_limit
getId() : string|null: Gets id
getImportExport() : bool|null: Gets import_export
getInboxForwarders() : bool: Gets inbox_forwarders
getInboxRepliers() : bool: Gets inbox_repliers
getInboxRulesets() : bool: Gets inbox_rulesets
getInboxWarmUp() : bool|null: Gets inbox_warm_up
getIncludedMonthlyWarmupCreditsPerSender() : int: Gets included_monthly_warmup_credits_per_sender
getIncludedWarmupSenderSeats() : int: Gets included_warmup_sender_seats
getIsDecimalLess() : bool: Gets is_decimal_less
getLoadTest() : bool|null: Gets load_test
getMaxAutomatedInboxPlacementSchedules() : int: Gets max_automated_inbox_placement_schedules
getMaxEmailSizeMb() : int: Gets max_email_size_mb
getMaxInboxPlacementSeedAddressesPerTest() : int: Gets max_inbox_placement_seed_addresses_per_test
getMaxUniqueRecipients() : int: Gets max_unique_recipients
getMembers() : int: Gets members
getMetered() : bool: Gets metered
getModelName() : string: The original name of the model.
getMonthlyGetMailServerRecords() : int: Gets monthly_get_mail_server_records
getMonthlyInboxes() : int: Gets monthly_inboxes
getMonthlyReceive() : int: Gets monthly_receive
getMonthlySend() : int: Gets monthly_send
getMonthlyTemporaryInboxes() : int|null: Gets monthly_temporary_inboxes
getMonthlyVerifyEmailAddress() : int: Gets monthly_verify_email_address
getOauthConnections() : int: Gets oauth_connections
getOidcSso() : bool|null: Gets oidc_sso
getOrganizations() : int|null: Gets organizations
getPassword() : bool: Gets password
getPermanentInbox() : bool: Gets permanent_inbox
getPermitsExternalSend() : bool|null: Gets permits_external_send
getPhoneNumbers() : int: Gets phone_numbers
getPhoneProvisionRequestLimit() : int: Gets phone_provision_request_limit
getRecipients() : int: Gets recipients
getSamlSso() : bool|null: Gets saml_sso
getScimProvisioning() : bool|null: Gets scim_provisioning
getScreenshots() : bool|null: Gets screenshots
getSendWithQueue() : bool|null: Gets send_with_queue
getStorageBytes() : int: Gets storage_bytes
getSubscriptionId() : string|null: Gets subscription_id
getSubscriptionSchedule() : string: Gets subscription_schedule
getSubscriptionScheduleAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getSubscriptionStatus() : string|null: Gets subscription_status
getSubscriptionStatusAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getSubscriptionStatusIsBad() : bool: Gets subscription_status_is_bad
getSubscriptionType() : string: Gets subscription_type
getSubscriptionTypeAllowableValues() : 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)
getThreads() : int: Gets threads
getTotalInboxes() : int: Gets total_inboxes
getTotalPermanentInboxes() : int|null: Gets total_permanent_inboxes
getTrackingPixels() : bool: Gets tracking_pixels
getTrialAdjustedAt() : DateTime|null: Gets trial_adjusted_at
getTrialAdjustmentReason() : string|null: Gets trial_adjustment_reason
getTrialDays() : int|null: Gets trial_days
getTrialEnd() : DateTime|null: Gets trial_end
getTrialStart() : DateTime|null: Gets trial_start
getUpdatedAt() : DateTime: Gets updated_at
getUserId() : string: Gets user_id
getUserPermissions() : bool|null: Gets user_permissions
getVirtualTotpDevices() : bool|null: Gets virtual_totp_devices
getWarmupControlledRecipientCreditWeight() : int: Gets warmup_controlled_recipient_credit_weight
getWarmupPremiumRecipientCreditWeight() : int: Gets warmup_premium_recipient_credit_weight
getWarmupPremiumSeedAccess() : bool|null: Gets warmup_premium_seed_access
getWebhooks() : bool: Gets webhooks
getZapier() : bool: Gets zapier
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
setAgents() : self: Sets agents
setAiDestinationSheets() : self: Sets ai_destination_sheets
setAiTransformers() : self: Sets ai_transformers
setAliases() : self: Sets aliases
setAttachmentAutomations() : self: Sets attachment_automations
setAttachments() : self: Sets attachments
setAuditLogs() : self: Sets audit_logs
setBackup() : self: Sets backup
setBulk() : self: Sets bulk
setCampaignProbe() : self: Sets campaign_probe
setCancelAt() : self: Sets cancel_at
setContacts() : self: Sets contacts
setCost() : self: Sets cost
setCostMajor() : self: Sets cost_major
setCreatedAt() : self: Sets created_at
setCurrency() : self: Sets currency
setCurrentPeriodEnd() : self: Sets current_period_end
setCurrentPeriodStart() : self: Sets current_period_start
setCustomerId() : self: Sets customer_id
setDailyReceive() : self: Sets daily_receive
setDailySend() : self: Sets daily_send
setDeliverabilityTest() : self: Sets deliverability_test
setDemoDaysRemaining() : self: Sets demo_days_remaining
setDevicePreviews() : self: Sets device_previews
setDomainMonitor() : self: Sets domain_monitor
setDomains() : self: Sets domains
setEmailAudit() : self: Sets email_audit
setEmailFeatureCheck() : self: Sets email_feature_check
setEnvironments() : self: Sets environments
setExternalPlanId() : self: Sets external_plan_id
setExternalValidationPlanId() : self: Sets external_validation_plan_id
setExternalValidationSubscriptionItemId() : self: Sets external_validation_subscription_item_id
setGmailInboxConnection() : self: Sets gmail_inbox_connection
setGmailInboxConnectionLimit() : self: Sets gmail_inbox_connection_limit
setId() : self: Sets id
setImportExport() : self: Sets import_export
setInboxForwarders() : self: Sets inbox_forwarders
setInboxRepliers() : self: Sets inbox_repliers
setInboxRulesets() : self: Sets inbox_rulesets
setInboxWarmUp() : self: Sets inbox_warm_up
setIncludedMonthlyWarmupCreditsPerSender() : self: Sets included_monthly_warmup_credits_per_sender
setIncludedWarmupSenderSeats() : self: Sets included_warmup_sender_seats
setIsDecimalLess() : self: Sets is_decimal_less
setLoadTest() : self: Sets load_test
setMaxAutomatedInboxPlacementSchedules() : self: Sets max_automated_inbox_placement_schedules
setMaxEmailSizeMb() : self: Sets max_email_size_mb
setMaxInboxPlacementSeedAddressesPerTest() : self: Sets max_inbox_placement_seed_addresses_per_test
setMaxUniqueRecipients() : self: Sets max_unique_recipients
setMembers() : self: Sets members
setMetered() : self: Sets metered
setMonthlyGetMailServerRecords() : self: Sets monthly_get_mail_server_records
setMonthlyInboxes() : self: Sets monthly_inboxes
setMonthlyReceive() : self: Sets monthly_receive
setMonthlySend() : self: Sets monthly_send
setMonthlyTemporaryInboxes() : self: Sets monthly_temporary_inboxes
setMonthlyVerifyEmailAddress() : self: Sets monthly_verify_email_address
setOauthConnections() : self: Sets oauth_connections
setOidcSso() : self: Sets oidc_sso
setOrganizations() : self: Sets organizations
setPassword() : self: Sets password
setPermanentInbox() : self: Sets permanent_inbox
setPermitsExternalSend() : self: Sets permits_external_send
setPhoneNumbers() : self: Sets phone_numbers
setPhoneProvisionRequestLimit() : self: Sets phone_provision_request_limit
setRecipients() : self: Sets recipients
setSamlSso() : self: Sets saml_sso
setScimProvisioning() : self: Sets scim_provisioning
setScreenshots() : self: Sets screenshots
setSendWithQueue() : self: Sets send_with_queue
setStorageBytes() : self: Sets storage_bytes
setSubscriptionId() : self: Sets subscription_id
setSubscriptionSchedule() : self: Sets subscription_schedule
setSubscriptionStatus() : self: Sets subscription_status
setSubscriptionStatusIsBad() : self: Sets subscription_status_is_bad
setSubscriptionType() : self: Sets subscription_type
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setThreads() : self: Sets threads
setTotalInboxes() : self: Sets total_inboxes
setTotalPermanentInboxes() : self: Sets total_permanent_inboxes
setTrackingPixels() : self: Sets tracking_pixels
setTrialAdjustedAt() : self: Sets trial_adjusted_at
setTrialAdjustmentReason() : self: Sets trial_adjustment_reason
setTrialDays() : self: Sets trial_days
setTrialEnd() : self: Sets trial_end
setTrialStart() : self: Sets trial_start
setUpdatedAt() : self: Sets updated_at
setUserId() : self: Sets user_id
setUserPermissions() : self: Sets user_permissions
setVirtualTotpDevices() : self: Sets virtual_totp_devices
setWarmupControlledRecipientCreditWeight() : self: Sets warmup_controlled_recipient_credit_weight
setWarmupPremiumRecipientCreditWeight() : self: Sets warmup_premium_recipient_credit_weight
setWarmupPremiumSeedAccess() : self: Sets warmup_premium_seed_access
setWebhooks() : self: Sets webhooks
setZapier() : self: Sets zapier
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

CURRENCY_AUD


    public
        mixed
    CURRENCY_AUD
    = 'AUD'

CURRENCY_CAD


    public
        mixed
    CURRENCY_CAD
    = 'CAD'

CURRENCY_CHF


    public
        mixed
    CURRENCY_CHF
    = 'CHF'

CURRENCY_CNY


    public
        mixed
    CURRENCY_CNY
    = 'CNY'

CURRENCY_EUR


    public
        mixed
    CURRENCY_EUR
    = 'EUR'

CURRENCY_GBP


    public
        mixed
    CURRENCY_GBP
    = 'GBP'

CURRENCY_INR


    public
        mixed
    CURRENCY_INR
    = 'INR'

CURRENCY_JPY


    public
        mixed
    CURRENCY_JPY
    = 'JPY'

CURRENCY_NZD


    public
        mixed
    CURRENCY_NZD
    = 'NZD'

CURRENCY_USD


    public
        mixed
    CURRENCY_USD
    = 'USD'

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

SUBSCRIPTION_SCHEDULE_MONTHLY


    public
        mixed
    SUBSCRIPTION_SCHEDULE_MONTHLY
    = 'MONTHLY'

SUBSCRIPTION_SCHEDULE_YEARLY


    public
        mixed
    SUBSCRIPTION_SCHEDULE_YEARLY
    = 'YEARLY'

SUBSCRIPTION_STATUS_ACTIVE


    public
        mixed
    SUBSCRIPTION_STATUS_ACTIVE
    = 'active'

SUBSCRIPTION_STATUS_CANCELED


    public
        mixed
    SUBSCRIPTION_STATUS_CANCELED
    = 'canceled'

SUBSCRIPTION_STATUS_INCOMPLETE


    public
        mixed
    SUBSCRIPTION_STATUS_INCOMPLETE
    = 'incomplete'

SUBSCRIPTION_STATUS_INCOMPLETE_EXPIRED


    public
        mixed
    SUBSCRIPTION_STATUS_INCOMPLETE_EXPIRED
    = 'incomplete_expired'

SUBSCRIPTION_STATUS_PAST_DUE


    public
        mixed
    SUBSCRIPTION_STATUS_PAST_DUE
    = 'past_due'

SUBSCRIPTION_STATUS_PAUSED


    public
        mixed
    SUBSCRIPTION_STATUS_PAUSED
    = 'paused'

SUBSCRIPTION_STATUS_TRIALING


    public
        mixed
    SUBSCRIPTION_STATUS_TRIALING
    = 'trialing'

SUBSCRIPTION_STATUS_UNPAID


    public
        mixed
    SUBSCRIPTION_STATUS_UNPAID
    = 'unpaid'

SUBSCRIPTION_TYPE_ENTERPRISE


    public
        mixed
    SUBSCRIPTION_TYPE_ENTERPRISE
    = 'ENTERPRISE'

SUBSCRIPTION_TYPE_PRO


    public
        mixed
    SUBSCRIPTION_TYPE_PRO
    = 'PRO'

SUBSCRIPTION_TYPE_PRO_MONTHLY


    public
        mixed
    SUBSCRIPTION_TYPE_PRO_MONTHLY
    = 'PRO_MONTHLY'

SUBSCRIPTION_TYPE_STARTER


    public
        mixed
    SUBSCRIPTION_TYPE_STARTER
    = 'STARTER'

SUBSCRIPTION_TYPE_TEAM


    public
        mixed
    SUBSCRIPTION_TYPE_TEAM
    = 'TEAM'

$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', 'user_id' => 'userId', 'customer_id' => 'customerId', 'subscription_id' => 'subscriptionId', 'currency' => 'currency', 'cost' => 'cost', 'is_decimal_less' => 'isDecimalLess', 'subscription_type' => 'subscriptionType', 'subscription_schedule' => 'subscriptionSchedule', 'monthly_inboxes' => 'monthlyInboxes', 'monthly_receive' => 'monthlyReceive', 'oauth_connections' => 'oauthConnections', 'storage_bytes' => 'storageBytes', 'total_inboxes' => 'totalInboxes', 'phone_numbers' => 'phoneNumbers', 'phone_provision_request_limit' => 'phoneProvisionRequestLimit', 'monthly_send' => 'monthlySend', 'domains' => 'domains', 'members' => 'members', 'aliases' => 'aliases', 'threads' => 'threads', 'recipients' => 'recipients', 'attachments' => 'attachments', 'bulk' => 'bulk', 'permanent_inbox' => 'permanentInbox', 'contacts' => 'contacts', 'webhooks' => 'webhooks', 'password' => 'password', 'inbox_rulesets' => 'inboxRulesets', 'zapier' => 'zapier', 'tracking_pixels' => 'trackingPixels', 'inbox_forwarders' => 'inboxForwarders', 'inbox_repliers' => 'inboxRepliers', 'attachment_automations' => 'attachmentAutomations', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'monthly_get_mail_server_records' => 'monthlyGetMailServerRecords', 'monthly_verify_email_address' => 'monthlyVerifyEmailAddress', 'metered' => 'metered', 'max_unique_recipients' => 'maxUniqueRecipients', 'external_plan_id' => 'externalPlanId', 'external_validation_plan_id' => 'externalValidationPlanId', 'external_validation_subscription_item_id' => 'externalValidationSubscriptionItemId', 'send_with_queue' => 'sendWithQueue', 'trial_days' => 'trialDays', 'cancel_at' => 'cancelAt', 'trial_end' => 'trialEnd', 'trial_start' => 'trialStart', 'trial_adjustment_reason' => 'trialAdjustmentReason', 'trial_adjusted_at' => 'trialAdjustedAt', 'saml_sso' => 'samlSSO', 'oidc_sso' => 'oidcSSO', 'scim_provisioning' => 'scimProvisioning', 'demo_days_remaining' => 'demoDaysRemaining', 'organizations' => 'organizations', 'email_feature_check' => 'emailFeatureCheck', 'backup' => 'backup', 'screenshots' => 'screenshots', 'device_previews' => 'devicePreviews', 'user_permissions' => 'userPermissions', 'environments' => 'environments', 'import_export' => 'importExport', 'audit_logs' => 'auditLogs', 'deliverability_test' => 'deliverabilityTest', 'email_audit' => 'emailAudit', 'inbox_warm_up' => 'inboxWarmUp', 'warmup_premium_seed_access' => 'warmupPremiumSeedAccess', 'domain_monitor' => 'domainMonitor', 'campaign_probe' => 'campaignProbe', 'virtual_totp_devices' => 'virtualTotpDevices', 'current_period_end' => 'currentPeriodEnd', 'current_period_start' => 'currentPeriodStart', 'subscription_status' => 'subscriptionStatus', 'subscription_status_is_bad' => 'subscriptionStatusIsBad', 'daily_receive' => 'dailyReceive', 'daily_send' => 'dailySend', 'max_email_size_mb' => 'maxEmailSizeMb', 'ai_transformers' => 'aiTransformers', 'gmail_inbox_connection' => 'gmailInboxConnection', 'ai_destination_sheets' => 'aiDestinationSheets', 'gmail_inbox_connection_limit' => 'gmailInboxConnectionLimit', 'permits_external_send' => 'permitsExternalSend', 'total_permanent_inboxes' => 'totalPermanentInboxes', 'monthly_temporary_inboxes' => 'monthlyTemporaryInboxes', 'agents' => 'agents', 'max_inbox_placement_seed_addresses_per_test' => 'maxInboxPlacementSeedAddressesPerTest', 'max_automated_inbox_placement_schedules' => 'maxAutomatedInboxPlacementSchedules', 'included_warmup_sender_seats' => 'includedWarmupSenderSeats', 'included_monthly_warmup_credits_per_sender' => 'includedMonthlyWarmupCreditsPerSender', 'warmup_controlled_recipient_credit_weight' => 'warmupControlledRecipientCreditWeight', 'warmup_premium_recipient_credit_weight' => 'warmupPremiumRecipientCreditWeight', 'load_test' => 'loadTest', 'cost_major' => 'costMajor']

$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', 'user_id' => 'getUserId', 'customer_id' => 'getCustomerId', 'subscription_id' => 'getSubscriptionId', 'currency' => 'getCurrency', 'cost' => 'getCost', 'is_decimal_less' => 'getIsDecimalLess', 'subscription_type' => 'getSubscriptionType', 'subscription_schedule' => 'getSubscriptionSchedule', 'monthly_inboxes' => 'getMonthlyInboxes', 'monthly_receive' => 'getMonthlyReceive', 'oauth_connections' => 'getOauthConnections', 'storage_bytes' => 'getStorageBytes', 'total_inboxes' => 'getTotalInboxes', 'phone_numbers' => 'getPhoneNumbers', 'phone_provision_request_limit' => 'getPhoneProvisionRequestLimit', 'monthly_send' => 'getMonthlySend', 'domains' => 'getDomains', 'members' => 'getMembers', 'aliases' => 'getAliases', 'threads' => 'getThreads', 'recipients' => 'getRecipients', 'attachments' => 'getAttachments', 'bulk' => 'getBulk', 'permanent_inbox' => 'getPermanentInbox', 'contacts' => 'getContacts', 'webhooks' => 'getWebhooks', 'password' => 'getPassword', 'inbox_rulesets' => 'getInboxRulesets', 'zapier' => 'getZapier', 'tracking_pixels' => 'getTrackingPixels', 'inbox_forwarders' => 'getInboxForwarders', 'inbox_repliers' => 'getInboxRepliers', 'attachment_automations' => 'getAttachmentAutomations', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'monthly_get_mail_server_records' => 'getMonthlyGetMailServerRecords', 'monthly_verify_email_address' => 'getMonthlyVerifyEmailAddress', 'metered' => 'getMetered', 'max_unique_recipients' => 'getMaxUniqueRecipients', 'external_plan_id' => 'getExternalPlanId', 'external_validation_plan_id' => 'getExternalValidationPlanId', 'external_validation_subscription_item_id' => 'getExternalValidationSubscriptionItemId', 'send_with_queue' => 'getSendWithQueue', 'trial_days' => 'getTrialDays', 'cancel_at' => 'getCancelAt', 'trial_end' => 'getTrialEnd', 'trial_start' => 'getTrialStart', 'trial_adjustment_reason' => 'getTrialAdjustmentReason', 'trial_adjusted_at' => 'getTrialAdjustedAt', 'saml_sso' => 'getSamlSso', 'oidc_sso' => 'getOidcSso', 'scim_provisioning' => 'getScimProvisioning', 'demo_days_remaining' => 'getDemoDaysRemaining', 'organizations' => 'getOrganizations', 'email_feature_check' => 'getEmailFeatureCheck', 'backup' => 'getBackup', 'screenshots' => 'getScreenshots', 'device_previews' => 'getDevicePreviews', 'user_permissions' => 'getUserPermissions', 'environments' => 'getEnvironments', 'import_export' => 'getImportExport', 'audit_logs' => 'getAuditLogs', 'deliverability_test' => 'getDeliverabilityTest', 'email_audit' => 'getEmailAudit', 'inbox_warm_up' => 'getInboxWarmUp', 'warmup_premium_seed_access' => 'getWarmupPremiumSeedAccess', 'domain_monitor' => 'getDomainMonitor', 'campaign_probe' => 'getCampaignProbe', 'virtual_totp_devices' => 'getVirtualTotpDevices', 'current_period_end' => 'getCurrentPeriodEnd', 'current_period_start' => 'getCurrentPeriodStart', 'subscription_status' => 'getSubscriptionStatus', 'subscription_status_is_bad' => 'getSubscriptionStatusIsBad', 'daily_receive' => 'getDailyReceive', 'daily_send' => 'getDailySend', 'max_email_size_mb' => 'getMaxEmailSizeMb', 'ai_transformers' => 'getAiTransformers', 'gmail_inbox_connection' => 'getGmailInboxConnection', 'ai_destination_sheets' => 'getAiDestinationSheets', 'gmail_inbox_connection_limit' => 'getGmailInboxConnectionLimit', 'permits_external_send' => 'getPermitsExternalSend', 'total_permanent_inboxes' => 'getTotalPermanentInboxes', 'monthly_temporary_inboxes' => 'getMonthlyTemporaryInboxes', 'agents' => 'getAgents', 'max_inbox_placement_seed_addresses_per_test' => 'getMaxInboxPlacementSeedAddressesPerTest', 'max_automated_inbox_placement_schedules' => 'getMaxAutomatedInboxPlacementSchedules', 'included_warmup_sender_seats' => 'getIncludedWarmupSenderSeats', 'included_monthly_warmup_credits_per_sender' => 'getIncludedMonthlyWarmupCreditsPerSender', 'warmup_controlled_recipient_credit_weight' => 'getWarmupControlledRecipientCreditWeight', 'warmup_premium_recipient_credit_weight' => 'getWarmupPremiumRecipientCreditWeight', 'load_test' => 'getLoadTest', 'cost_major' => 'getCostMajor']

$openAPIFormats

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


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['id' => 'uuid', 'user_id' => 'uuid', 'customer_id' => null, 'subscription_id' => null, 'currency' => null, 'cost' => 'int32', 'is_decimal_less' => null, 'subscription_type' => null, 'subscription_schedule' => null, 'monthly_inboxes' => 'int32', 'monthly_receive' => 'int32', 'oauth_connections' => 'int32', 'storage_bytes' => 'int64', 'total_inboxes' => 'int32', 'phone_numbers' => 'int32', 'phone_provision_request_limit' => 'int32', 'monthly_send' => 'int32', 'domains' => 'int32', 'members' => 'int32', 'aliases' => 'int32', 'threads' => 'int32', 'recipients' => 'int32', 'attachments' => null, 'bulk' => null, 'permanent_inbox' => null, 'contacts' => null, 'webhooks' => null, 'password' => null, 'inbox_rulesets' => null, 'zapier' => null, 'tracking_pixels' => null, 'inbox_forwarders' => null, 'inbox_repliers' => null, 'attachment_automations' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time', 'monthly_get_mail_server_records' => 'int32', 'monthly_verify_email_address' => 'int32', 'metered' => null, 'max_unique_recipients' => 'int32', 'external_plan_id' => null, 'external_validation_plan_id' => null, 'external_validation_subscription_item_id' => null, 'send_with_queue' => null, 'trial_days' => 'int32', 'cancel_at' => 'date-time', 'trial_end' => 'date-time', 'trial_start' => 'date-time', 'trial_adjustment_reason' => null, 'trial_adjusted_at' => 'date-time', 'saml_sso' => null, 'oidc_sso' => null, 'scim_provisioning' => null, 'demo_days_remaining' => 'int32', 'organizations' => 'int32', 'email_feature_check' => null, 'backup' => null, 'screenshots' => null, 'device_previews' => null, 'user_permissions' => null, 'environments' => null, 'import_export' => null, 'audit_logs' => null, 'deliverability_test' => null, 'email_audit' => null, 'inbox_warm_up' => null, 'warmup_premium_seed_access' => null, 'domain_monitor' => null, 'campaign_probe' => null, 'virtual_totp_devices' => null, 'current_period_end' => 'date-time', 'current_period_start' => 'date-time', 'subscription_status' => null, 'subscription_status_is_bad' => null, 'daily_receive' => 'int32', 'daily_send' => 'int32', 'max_email_size_mb' => 'int32', 'ai_transformers' => null, 'gmail_inbox_connection' => null, 'ai_destination_sheets' => null, 'gmail_inbox_connection_limit' => 'int32', 'permits_external_send' => null, 'total_permanent_inboxes' => 'int32', 'monthly_temporary_inboxes' => 'int32', 'agents' => 'int32', 'max_inbox_placement_seed_addresses_per_test' => 'int32', 'max_automated_inbox_placement_schedules' => 'int32', 'included_warmup_sender_seats' => 'int32', 'included_monthly_warmup_credits_per_sender' => 'int32', 'warmup_controlled_recipient_credit_weight' => 'int32', 'warmup_premium_recipient_credit_weight' => 'int32', 'load_test' => null, 'cost_major' => null]

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'AccountDto_subscription'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, mixed>
    $openAPINullables
     = ['id' => true, 'user_id' => false, 'customer_id' => true, 'subscription_id' => true, 'currency' => true, 'cost' => true, 'is_decimal_less' => false, 'subscription_type' => false, 'subscription_schedule' => false, 'monthly_inboxes' => false, 'monthly_receive' => false, 'oauth_connections' => false, 'storage_bytes' => false, 'total_inboxes' => false, 'phone_numbers' => false, 'phone_provision_request_limit' => false, 'monthly_send' => false, 'domains' => false, 'members' => false, 'aliases' => false, 'threads' => false, 'recipients' => false, 'attachments' => false, 'bulk' => false, 'permanent_inbox' => false, 'contacts' => false, 'webhooks' => false, 'password' => false, 'inbox_rulesets' => false, 'zapier' => false, 'tracking_pixels' => false, 'inbox_forwarders' => false, 'inbox_repliers' => false, 'attachment_automations' => false, 'created_at' => false, 'updated_at' => false, 'monthly_get_mail_server_records' => false, 'monthly_verify_email_address' => false, 'metered' => false, 'max_unique_recipients' => false, 'external_plan_id' => true, 'external_validation_plan_id' => true, 'external_validation_subscription_item_id' => true, 'send_with_queue' => true, 'trial_days' => true, 'cancel_at' => true, 'trial_end' => true, 'trial_start' => true, 'trial_adjustment_reason' => true, 'trial_adjusted_at' => true, 'saml_sso' => true, 'oidc_sso' => true, 'scim_provisioning' => true, 'demo_days_remaining' => true, 'organizations' => true, 'email_feature_check' => true, 'backup' => true, 'screenshots' => true, 'device_previews' => true, 'user_permissions' => true, 'environments' => true, 'import_export' => true, 'audit_logs' => true, 'deliverability_test' => true, 'email_audit' => true, 'inbox_warm_up' => true, 'warmup_premium_seed_access' => true, 'domain_monitor' => true, 'campaign_probe' => true, 'virtual_totp_devices' => true, 'current_period_end' => false, 'current_period_start' => false, 'subscription_status' => true, 'subscription_status_is_bad' => false, 'daily_receive' => false, 'daily_send' => false, 'max_email_size_mb' => false, 'ai_transformers' => false, 'gmail_inbox_connection' => false, 'ai_destination_sheets' => false, 'gmail_inbox_connection_limit' => false, 'permits_external_send' => true, 'total_permanent_inboxes' => true, 'monthly_temporary_inboxes' => true, 'agents' => true, 'max_inbox_placement_seed_addresses_per_test' => false, 'max_automated_inbox_placement_schedules' => false, 'included_warmup_sender_seats' => false, 'included_monthly_warmup_credits_per_sender' => false, 'warmup_controlled_recipient_credit_weight' => false, 'warmup_premium_recipient_credit_weight' => false, 'load_test' => true, 'cost_major' => 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', 'user_id' => 'string', 'customer_id' => 'string', 'subscription_id' => 'string', 'currency' => 'string', 'cost' => 'int', 'is_decimal_less' => 'bool', 'subscription_type' => 'string', 'subscription_schedule' => 'string', 'monthly_inboxes' => 'int', 'monthly_receive' => 'int', 'oauth_connections' => 'int', 'storage_bytes' => 'int', 'total_inboxes' => 'int', 'phone_numbers' => 'int', 'phone_provision_request_limit' => 'int', 'monthly_send' => 'int', 'domains' => 'int', 'members' => 'int', 'aliases' => 'int', 'threads' => 'int', 'recipients' => 'int', 'attachments' => 'bool', 'bulk' => 'bool', 'permanent_inbox' => 'bool', 'contacts' => 'bool', 'webhooks' => 'bool', 'password' => 'bool', 'inbox_rulesets' => 'bool', 'zapier' => 'bool', 'tracking_pixels' => 'bool', 'inbox_forwarders' => 'bool', 'inbox_repliers' => 'bool', 'attachment_automations' => 'bool', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'monthly_get_mail_server_records' => 'int', 'monthly_verify_email_address' => 'int', 'metered' => 'bool', 'max_unique_recipients' => 'int', 'external_plan_id' => 'string', 'external_validation_plan_id' => 'string', 'external_validation_subscription_item_id' => 'string', 'send_with_queue' => 'bool', 'trial_days' => 'int', 'cancel_at' => '\\DateTime', 'trial_end' => '\\DateTime', 'trial_start' => '\\DateTime', 'trial_adjustment_reason' => 'string', 'trial_adjusted_at' => '\\DateTime', 'saml_sso' => 'bool', 'oidc_sso' => 'bool', 'scim_provisioning' => 'bool', 'demo_days_remaining' => 'int', 'organizations' => 'int', 'email_feature_check' => 'bool', 'backup' => 'bool', 'screenshots' => 'bool', 'device_previews' => 'bool', 'user_permissions' => 'bool', 'environments' => 'bool', 'import_export' => 'bool', 'audit_logs' => 'bool', 'deliverability_test' => 'bool', 'email_audit' => 'bool', 'inbox_warm_up' => 'bool', 'warmup_premium_seed_access' => 'bool', 'domain_monitor' => 'bool', 'campaign_probe' => 'bool', 'virtual_totp_devices' => 'bool', 'current_period_end' => '\\DateTime', 'current_period_start' => '\\DateTime', 'subscription_status' => 'string', 'subscription_status_is_bad' => 'bool', 'daily_receive' => 'int', 'daily_send' => 'int', 'max_email_size_mb' => 'int', 'ai_transformers' => 'bool', 'gmail_inbox_connection' => 'bool', 'ai_destination_sheets' => 'bool', 'gmail_inbox_connection_limit' => 'int', 'permits_external_send' => 'bool', 'total_permanent_inboxes' => 'int', 'monthly_temporary_inboxes' => 'int', 'agents' => 'int', 'max_inbox_placement_seed_addresses_per_test' => 'int', 'max_automated_inbox_placement_schedules' => 'int', 'included_warmup_sender_seats' => 'int', 'included_monthly_warmup_credits_per_sender' => 'int', 'warmup_controlled_recipient_credit_weight' => 'int', 'warmup_premium_recipient_credit_weight' => 'int', 'load_test' => 'bool', 'cost_major' => 'float']

$setters

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


    protected
    static    array<string|int, string>
    $setters
     = ['id' => 'setId', 'user_id' => 'setUserId', 'customer_id' => 'setCustomerId', 'subscription_id' => 'setSubscriptionId', 'currency' => 'setCurrency', 'cost' => 'setCost', 'is_decimal_less' => 'setIsDecimalLess', 'subscription_type' => 'setSubscriptionType', 'subscription_schedule' => 'setSubscriptionSchedule', 'monthly_inboxes' => 'setMonthlyInboxes', 'monthly_receive' => 'setMonthlyReceive', 'oauth_connections' => 'setOauthConnections', 'storage_bytes' => 'setStorageBytes', 'total_inboxes' => 'setTotalInboxes', 'phone_numbers' => 'setPhoneNumbers', 'phone_provision_request_limit' => 'setPhoneProvisionRequestLimit', 'monthly_send' => 'setMonthlySend', 'domains' => 'setDomains', 'members' => 'setMembers', 'aliases' => 'setAliases', 'threads' => 'setThreads', 'recipients' => 'setRecipients', 'attachments' => 'setAttachments', 'bulk' => 'setBulk', 'permanent_inbox' => 'setPermanentInbox', 'contacts' => 'setContacts', 'webhooks' => 'setWebhooks', 'password' => 'setPassword', 'inbox_rulesets' => 'setInboxRulesets', 'zapier' => 'setZapier', 'tracking_pixels' => 'setTrackingPixels', 'inbox_forwarders' => 'setInboxForwarders', 'inbox_repliers' => 'setInboxRepliers', 'attachment_automations' => 'setAttachmentAutomations', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'monthly_get_mail_server_records' => 'setMonthlyGetMailServerRecords', 'monthly_verify_email_address' => 'setMonthlyVerifyEmailAddress', 'metered' => 'setMetered', 'max_unique_recipients' => 'setMaxUniqueRecipients', 'external_plan_id' => 'setExternalPlanId', 'external_validation_plan_id' => 'setExternalValidationPlanId', 'external_validation_subscription_item_id' => 'setExternalValidationSubscriptionItemId', 'send_with_queue' => 'setSendWithQueue', 'trial_days' => 'setTrialDays', 'cancel_at' => 'setCancelAt', 'trial_end' => 'setTrialEnd', 'trial_start' => 'setTrialStart', 'trial_adjustment_reason' => 'setTrialAdjustmentReason', 'trial_adjusted_at' => 'setTrialAdjustedAt', 'saml_sso' => 'setSamlSso', 'oidc_sso' => 'setOidcSso', 'scim_provisioning' => 'setScimProvisioning', 'demo_days_remaining' => 'setDemoDaysRemaining', 'organizations' => 'setOrganizations', 'email_feature_check' => 'setEmailFeatureCheck', 'backup' => 'setBackup', 'screenshots' => 'setScreenshots', 'device_previews' => 'setDevicePreviews', 'user_permissions' => 'setUserPermissions', 'environments' => 'setEnvironments', 'import_export' => 'setImportExport', 'audit_logs' => 'setAuditLogs', 'deliverability_test' => 'setDeliverabilityTest', 'email_audit' => 'setEmailAudit', 'inbox_warm_up' => 'setInboxWarmUp', 'warmup_premium_seed_access' => 'setWarmupPremiumSeedAccess', 'domain_monitor' => 'setDomainMonitor', 'campaign_probe' => 'setCampaignProbe', 'virtual_totp_devices' => 'setVirtualTotpDevices', 'current_period_end' => 'setCurrentPeriodEnd', 'current_period_start' => 'setCurrentPeriodStart', 'subscription_status' => 'setSubscriptionStatus', 'subscription_status_is_bad' => 'setSubscriptionStatusIsBad', 'daily_receive' => 'setDailyReceive', 'daily_send' => 'setDailySend', 'max_email_size_mb' => 'setMaxEmailSizeMb', 'ai_transformers' => 'setAiTransformers', 'gmail_inbox_connection' => 'setGmailInboxConnection', 'ai_destination_sheets' => 'setAiDestinationSheets', 'gmail_inbox_connection_limit' => 'setGmailInboxConnectionLimit', 'permits_external_send' => 'setPermitsExternalSend', 'total_permanent_inboxes' => 'setTotalPermanentInboxes', 'monthly_temporary_inboxes' => 'setMonthlyTemporaryInboxes', 'agents' => 'setAgents', 'max_inbox_placement_seed_addresses_per_test' => 'setMaxInboxPlacementSeedAddressesPerTest', 'max_automated_inbox_placement_schedules' => 'setMaxAutomatedInboxPlacementSchedules', 'included_warmup_sender_seats' => 'setIncludedWarmupSenderSeats', 'included_monthly_warmup_credits_per_sender' => 'setIncludedMonthlyWarmupCreditsPerSender', 'warmup_controlled_recipient_credit_weight' => 'setWarmupControlledRecipientCreditWeight', 'warmup_premium_recipient_credit_weight' => 'setWarmupPremiumRecipientCreditWeight', 'load_test' => 'setLoadTest', 'cost_major' => 'setCostMajor']

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

getAgents()

Gets agents


    public
                    getAgents() : int|null

Return values

int|null —

getAiDestinationSheets()

Gets ai_destination_sheets


    public
                    getAiDestinationSheets() : bool

Return values

bool —

getAiTransformers()

Gets ai_transformers


    public
                    getAiTransformers() : bool

Return values

bool —

getAliases()

Gets aliases


    public
                    getAliases() : int

Return values

int —

getAttachmentAutomations()

Gets attachment_automations


    public
                    getAttachmentAutomations() : bool

Return values

bool —

getAttachments()

Gets attachments


    public
                    getAttachments() : bool

Return values

bool —

getAuditLogs()

Gets audit_logs


    public
                    getAuditLogs() : bool|null

Return values

bool|null —

getBackup()

Gets backup


    public
                    getBackup() : bool|null

Return values

bool|null —

getBulk()

Gets bulk


    public
                    getBulk() : bool

Return values

bool —

getCampaignProbe()

Gets campaign_probe


    public
                    getCampaignProbe() : bool|null

Return values

bool|null —

getCancelAt()

Gets cancel_at


    public
                    getCancelAt() : DateTime|null

Return values

DateTime|null —

getContacts()

Gets contacts


    public
                    getContacts() : bool

Return values

bool —

getCost()

Gets cost


    public
                    getCost() : int|null

Return values

int|null —

getCostMajor()

Gets cost_major


    public
                    getCostMajor() : float|null

Return values

float|null —

getCreatedAt()

Gets created_at


    public
                    getCreatedAt() : DateTime

Return values

DateTime —

getCurrency()

Gets currency


    public
                    getCurrency() : string|null

Return values

string|null —

getCurrencyAllowableValues()

Gets allowable values of the enum


    public
                    getCurrencyAllowableValues() : array<string|int, string>

Return values

array<string|int, string> —

getCurrentPeriodEnd()

Gets current_period_end


    public
                    getCurrentPeriodEnd() : DateTime

Return values

DateTime —

getCurrentPeriodStart()

Gets current_period_start


    public
                    getCurrentPeriodStart() : DateTime

Return values

DateTime —

getCustomerId()

Gets customer_id


    public
                    getCustomerId() : string|null

Return values

string|null —

getDailyReceive()

Gets daily_receive


    public
                    getDailyReceive() : int

Return values

int —

getDailySend()

Gets daily_send


    public
                    getDailySend() : int

Return values

int —

getDeliverabilityTest()

Gets deliverability_test


    public
                    getDeliverabilityTest() : bool|null

Return values

bool|null —

getDemoDaysRemaining()

Gets demo_days_remaining


    public
                    getDemoDaysRemaining() : int|null

Return values

int|null —

getDevicePreviews()

Gets device_previews


    public
                    getDevicePreviews() : bool|null

Return values

bool|null —

getDomainMonitor()

Gets domain_monitor


    public
                    getDomainMonitor() : bool|null

Return values

bool|null —

getDomains()

Gets domains


    public
                    getDomains() : int

Return values

int —

getEmailAudit()

Gets email_audit


    public
                    getEmailAudit() : bool|null

Return values

bool|null —

getEmailFeatureCheck()

Gets email_feature_check


    public
                    getEmailFeatureCheck() : bool|null

Return values

bool|null —

getEnvironments()

Gets environments


    public
                    getEnvironments() : bool|null

Return values

bool|null —

getExternalPlanId()

Gets external_plan_id


    public
                    getExternalPlanId() : string|null

Return values

string|null —

getExternalValidationPlanId()

Gets external_validation_plan_id


    public
                    getExternalValidationPlanId() : string|null

Return values

string|null —

getExternalValidationSubscriptionItemId()

Gets external_validation_subscription_item_id


    public
                    getExternalValidationSubscriptionItemId() : string|null

Return values

string|null —

getGmailInboxConnection()

Gets gmail_inbox_connection


    public
                    getGmailInboxConnection() : bool

Return values

bool —

getGmailInboxConnectionLimit()

Gets gmail_inbox_connection_limit


    public
                    getGmailInboxConnectionLimit() : int

Return values

int —

getId()

Gets id


    public
                    getId() : string|null

Return values

string|null —

getImportExport()

Gets import_export


    public
                    getImportExport() : bool|null

Return values

bool|null —

getInboxForwarders()

Gets inbox_forwarders


    public
                    getInboxForwarders() : bool

Return values

bool —

getInboxRepliers()

Gets inbox_repliers


    public
                    getInboxRepliers() : bool

Return values

bool —

getInboxRulesets()

Gets inbox_rulesets


    public
                    getInboxRulesets() : bool

Return values

bool —

getInboxWarmUp()

Gets inbox_warm_up


    public
                    getInboxWarmUp() : bool|null

Return values

bool|null —

getIncludedMonthlyWarmupCreditsPerSender()

Gets included_monthly_warmup_credits_per_sender


    public
                    getIncludedMonthlyWarmupCreditsPerSender() : int

Return values

int —

getIncludedWarmupSenderSeats()

Gets included_warmup_sender_seats


    public
                    getIncludedWarmupSenderSeats() : int

Return values

int —

getIsDecimalLess()

Gets is_decimal_less


    public
                    getIsDecimalLess() : bool

Return values

bool —

getLoadTest()

Gets load_test


    public
                    getLoadTest() : bool|null

Return values

bool|null —

getMaxAutomatedInboxPlacementSchedules()

Gets max_automated_inbox_placement_schedules


    public
                    getMaxAutomatedInboxPlacementSchedules() : int

Return values

int —

getMaxEmailSizeMb()

Gets max_email_size_mb


    public
                    getMaxEmailSizeMb() : int

Return values

int —

getMaxInboxPlacementSeedAddressesPerTest()

Gets max_inbox_placement_seed_addresses_per_test


    public
                    getMaxInboxPlacementSeedAddressesPerTest() : int

Return values

int —

getMaxUniqueRecipients()

Gets max_unique_recipients


    public
                    getMaxUniqueRecipients() : int

Return values

int —

getMembers()

Gets members


    public
                    getMembers() : int

Return values

int —

getMetered()

Gets metered


    public
                    getMetered() : bool

Return values

bool —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getMonthlyGetMailServerRecords()

Gets monthly_get_mail_server_records


    public
                    getMonthlyGetMailServerRecords() : int

Return values

int —

getMonthlyInboxes()

Gets monthly_inboxes


    public
                    getMonthlyInboxes() : int

Return values

int —

getMonthlyReceive()

Gets monthly_receive


    public
                    getMonthlyReceive() : int

Return values

int —

getMonthlySend()

Gets monthly_send


    public
                    getMonthlySend() : int

Return values

int —

getMonthlyTemporaryInboxes()

Gets monthly_temporary_inboxes


    public
                    getMonthlyTemporaryInboxes() : int|null

Return values

int|null —

getMonthlyVerifyEmailAddress()

Gets monthly_verify_email_address


    public
                    getMonthlyVerifyEmailAddress() : int

Return values

int —

getOauthConnections()

Gets oauth_connections


    public
                    getOauthConnections() : int

Return values

int —

getOidcSso()

Gets oidc_sso


    public
                    getOidcSso() : bool|null

Return values

bool|null —

getOrganizations()

Gets organizations


    public
                    getOrganizations() : int|null

Return values

int|null —

getPassword()

Gets password


    public
                    getPassword() : bool

Return values

bool —

getPermanentInbox()

Gets permanent_inbox


    public
                    getPermanentInbox() : bool

Return values

bool —

getPermitsExternalSend()

Gets permits_external_send


    public
                    getPermitsExternalSend() : bool|null

Return values

bool|null —

getPhoneNumbers()

Gets phone_numbers


    public
                    getPhoneNumbers() : int

Return values

int —

getPhoneProvisionRequestLimit()

Gets phone_provision_request_limit


    public
                    getPhoneProvisionRequestLimit() : int

Return values

int —

getRecipients()

Gets recipients


    public
                    getRecipients() : int

Return values

int —

getSamlSso()

Gets saml_sso


    public
                    getSamlSso() : bool|null

Return values

bool|null —

getScimProvisioning()

Gets scim_provisioning


    public
                    getScimProvisioning() : bool|null

Return values

bool|null —

getScreenshots()

Gets screenshots


    public
                    getScreenshots() : bool|null

Return values

bool|null —

getSendWithQueue()

Gets send_with_queue


    public
                    getSendWithQueue() : bool|null

Return values

bool|null —

getStorageBytes()

Gets storage_bytes


    public
                    getStorageBytes() : int

Return values

int —

getSubscriptionId()

Gets subscription_id


    public
                    getSubscriptionId() : string|null

Return values

string|null —

getSubscriptionSchedule()

Gets subscription_schedule


    public
                    getSubscriptionSchedule() : string

Return values

string —

getSubscriptionScheduleAllowableValues()

Gets allowable values of the enum


    public
                    getSubscriptionScheduleAllowableValues() : array<string|int, string>

Return values

array<string|int, string> —

getSubscriptionStatus()

Gets subscription_status


    public
                    getSubscriptionStatus() : string|null

Return values

string|null —

getSubscriptionStatusAllowableValues()

Gets allowable values of the enum


    public
                    getSubscriptionStatusAllowableValues() : array<string|int, string>

Return values

array<string|int, string> —

getSubscriptionStatusIsBad()

Gets subscription_status_is_bad


    public
                    getSubscriptionStatusIsBad() : bool

Return values

bool —

getSubscriptionType()

Gets subscription_type


    public
                    getSubscriptionType() : string

Return values

string —

getSubscriptionTypeAllowableValues()

Gets allowable values of the enum


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

getThreads()

Gets threads


    public
                    getThreads() : int

Return values

int —

getTotalInboxes()

Gets total_inboxes


    public
                    getTotalInboxes() : int

Return values

int —

getTotalPermanentInboxes()

Gets total_permanent_inboxes


    public
                    getTotalPermanentInboxes() : int|null

Return values

int|null —

getTrackingPixels()

Gets tracking_pixels


    public
                    getTrackingPixels() : bool

Return values

bool —

getTrialAdjustedAt()

Gets trial_adjusted_at


    public
                    getTrialAdjustedAt() : DateTime|null

Return values

DateTime|null —

getTrialAdjustmentReason()

Gets trial_adjustment_reason


    public
                    getTrialAdjustmentReason() : string|null

Return values

string|null —

getTrialDays()

Gets trial_days


    public
                    getTrialDays() : int|null

Return values

int|null —

getTrialEnd()

Gets trial_end


    public
                    getTrialEnd() : DateTime|null

Return values

DateTime|null —

getTrialStart()

Gets trial_start


    public
                    getTrialStart() : DateTime|null

Return values

DateTime|null —

getUpdatedAt()

Gets updated_at


    public
                    getUpdatedAt() : DateTime

Return values

DateTime —

getUserId()

Gets user_id


    public
                    getUserId() : string

Return values

string —

getUserPermissions()

Gets user_permissions


    public
                    getUserPermissions() : bool|null

Return values

bool|null —

getVirtualTotpDevices()

Gets virtual_totp_devices


    public
                    getVirtualTotpDevices() : bool|null

Return values

bool|null —

getWarmupControlledRecipientCreditWeight()

Gets warmup_controlled_recipient_credit_weight


    public
                    getWarmupControlledRecipientCreditWeight() : int

Return values

int —

getWarmupPremiumRecipientCreditWeight()

Gets warmup_premium_recipient_credit_weight


    public
                    getWarmupPremiumRecipientCreditWeight() : int

Return values

int —

getWarmupPremiumSeedAccess()

Gets warmup_premium_seed_access


    public
                    getWarmupPremiumSeedAccess() : bool|null

Return values

bool|null —

getWebhooks()

Gets webhooks


    public
                    getWebhooks() : bool

Return values

bool —

getZapier()

Gets zapier


    public
                    getZapier() : bool

Return values

bool —

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

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

setAgents()

Sets agents


    public
                    setAgents(int|null $agents) : self

Parameters

$agents : int|null: Maximum active API or MCP agent connections. Null identifies a legacy unlimited subscription.

Return values

self —

setAiDestinationSheets()

Sets ai_destination_sheets


    public
                    setAiDestinationSheets(bool $ai_destination_sheets) : self

Parameters

$ai_destination_sheets : bool: ai_destination_sheets

Return values

self —

setAiTransformers()

Sets ai_transformers


    public
                    setAiTransformers(bool $ai_transformers) : self

Parameters

$ai_transformers : bool: ai_transformers

Return values

self —

setAliases()

Sets aliases


    public
                    setAliases(int $aliases) : self

Parameters

$aliases : int: aliases

Return values

self —

setAttachmentAutomations()

Sets attachment_automations


    public
                    setAttachmentAutomations(bool $attachment_automations) : self

Parameters

$attachment_automations : bool: attachment_automations

Return values

self —

setAttachments()

Sets attachments


    public
                    setAttachments(bool $attachments) : self

Parameters

$attachments : bool: attachments

Return values

self —

setAuditLogs()

Sets audit_logs


    public
                    setAuditLogs(bool|null $audit_logs) : self

Parameters

$audit_logs : bool|null: audit_logs

Return values

self —

setBackup()

Sets backup


    public
                    setBackup(bool|null $backup) : self

Parameters

$backup : bool|null: backup

Return values

self —

setBulk()

Sets bulk


    public
                    setBulk(bool $bulk) : self

Parameters

$bulk : bool: bulk

Return values

self —

setCampaignProbe()

Sets campaign_probe


    public
                    setCampaignProbe(bool|null $campaign_probe) : self

Parameters

$campaign_probe : bool|null: campaign_probe

Return values

self —

setCancelAt()

Sets cancel_at


    public
                    setCancelAt(DateTime|null $cancel_at) : self

Parameters

$cancel_at : DateTime|null: cancel_at

Return values

self —

setContacts()

Sets contacts


    public
                    setContacts(bool $contacts) : self

Parameters

$contacts : bool: contacts

Return values

self —

setCost()

Sets cost


    public
                    setCost(int|null $cost) : self

Parameters

$cost : int|null: cost

Return values

self —

setCostMajor()

Sets cost_major


    public
                    setCostMajor(float|null $cost_major) : self

Parameters

$cost_major : float|null: Subscription cost in major currency units for analytics and conversion value reporting.

Return values

self —

setCreatedAt()

Sets created_at


    public
                    setCreatedAt(DateTime $created_at) : self

Parameters

$created_at : DateTime: created_at

Return values

self —

setCurrency()

Sets currency


    public
                    setCurrency(string|null $currency) : self

Parameters

$currency : string|null: currency

Return values

self —

setCurrentPeriodEnd()

Sets current_period_end


    public
                    setCurrentPeriodEnd(DateTime $current_period_end) : self

Parameters

$current_period_end : DateTime: current_period_end

Return values

self —

setCurrentPeriodStart()

Sets current_period_start


    public
                    setCurrentPeriodStart(DateTime $current_period_start) : self

Parameters

$current_period_start : DateTime: current_period_start

Return values

self —

setCustomerId()

Sets customer_id


    public
                    setCustomerId(string|null $customer_id) : self

Parameters

$customer_id : string|null: customer_id

Return values

self —

setDailyReceive()

Sets daily_receive


    public
                    setDailyReceive(int $daily_receive) : self

Parameters

$daily_receive : int: daily_receive

Return values

self —

setDailySend()

Sets daily_send


    public
                    setDailySend(int $daily_send) : self

Parameters

$daily_send : int: daily_send

Return values

self —

setDeliverabilityTest()

Sets deliverability_test


    public
                    setDeliverabilityTest(bool|null $deliverability_test) : self

Parameters

$deliverability_test : bool|null: deliverability_test

Return values

self —

setDemoDaysRemaining()

Sets demo_days_remaining


    public
                    setDemoDaysRemaining(int|null $demo_days_remaining) : self

Parameters

$demo_days_remaining : int|null: demo_days_remaining

Return values

self —

setDevicePreviews()

Sets device_previews


    public
                    setDevicePreviews(bool|null $device_previews) : self

Parameters

$device_previews : bool|null: device_previews

Return values

self —

setDomainMonitor()

Sets domain_monitor


    public
                    setDomainMonitor(bool|null $domain_monitor) : self

Parameters

$domain_monitor : bool|null: domain_monitor

Return values

self —

setDomains()

Sets domains


    public
                    setDomains(int $domains) : self

Parameters

$domains : int: domains

Return values

self —

setEmailAudit()

Sets email_audit


    public
                    setEmailAudit(bool|null $email_audit) : self

Parameters

$email_audit : bool|null: email_audit

Return values

self —

setEmailFeatureCheck()

Sets email_feature_check


    public
                    setEmailFeatureCheck(bool|null $email_feature_check) : self

Parameters

$email_feature_check : bool|null: email_feature_check

Return values

self —

setEnvironments()

Sets environments


    public
                    setEnvironments(bool|null $environments) : self

Parameters

$environments : bool|null: environments

Return values

self —

setExternalPlanId()

Sets external_plan_id


    public
                    setExternalPlanId(string|null $external_plan_id) : self

Parameters

$external_plan_id : string|null: external_plan_id

Return values

self —

setExternalValidationPlanId()

Sets external_validation_plan_id


    public
                    setExternalValidationPlanId(string|null $external_validation_plan_id) : self

Parameters

$external_validation_plan_id : string|null: Use validation entity

Return values

self —

setExternalValidationSubscriptionItemId()

Sets external_validation_subscription_item_id


    public
                    setExternalValidationSubscriptionItemId(string|null $external_validation_subscription_item_id) : self

Parameters

$external_validation_subscription_item_id : string|null: Use validation entity

Return values

self —

setGmailInboxConnection()

Sets gmail_inbox_connection


    public
                    setGmailInboxConnection(bool $gmail_inbox_connection) : self

Parameters

$gmail_inbox_connection : bool: gmail_inbox_connection

Return values

self —

setGmailInboxConnectionLimit()

Sets gmail_inbox_connection_limit


    public
                    setGmailInboxConnectionLimit(int $gmail_inbox_connection_limit) : self

Parameters

$gmail_inbox_connection_limit : int: gmail_inbox_connection_limit

Return values

self —

setId()

Sets id


    public
                    setId(string|null $id) : self

Parameters

$id : string|null: id

Return values

self —

setImportExport()

Sets import_export


    public
                    setImportExport(bool|null $import_export) : self

Parameters

$import_export : bool|null: import_export

Return values

self —

setInboxForwarders()

Sets inbox_forwarders


    public
                    setInboxForwarders(bool $inbox_forwarders) : self

Parameters

$inbox_forwarders : bool: inbox_forwarders

Return values

self —

setInboxRepliers()

Sets inbox_repliers


    public
                    setInboxRepliers(bool $inbox_repliers) : self

Parameters

$inbox_repliers : bool: inbox_repliers

Return values

self —

setInboxRulesets()

Sets inbox_rulesets


    public
                    setInboxRulesets(bool $inbox_rulesets) : self

Parameters

$inbox_rulesets : bool: inbox_rulesets

Return values

self —

setInboxWarmUp()

Sets inbox_warm_up


    public
                    setInboxWarmUp(bool|null $inbox_warm_up) : self

Parameters

$inbox_warm_up : bool|null: inbox_warm_up

Return values

self —

setIncludedMonthlyWarmupCreditsPerSender()

Sets included_monthly_warmup_credits_per_sender


    public
                    setIncludedMonthlyWarmupCreditsPerSender(int $included_monthly_warmup_credits_per_sender) : self

Parameters

$included_monthly_warmup_credits_per_sender : int: included_monthly_warmup_credits_per_sender

Return values

self —

setIncludedWarmupSenderSeats()

Sets included_warmup_sender_seats


    public
                    setIncludedWarmupSenderSeats(int $included_warmup_sender_seats) : self

Parameters

$included_warmup_sender_seats : int: Warmup sender seats included by the base subscription before paid add-ons.

Return values

self —

setIsDecimalLess()

Sets is_decimal_less


    public
                    setIsDecimalLess(bool $is_decimal_less) : self

Parameters

$is_decimal_less : bool: is_decimal_less

Return values

self —

setLoadTest()

Sets load_test


    public
                    setLoadTest(bool|null $load_test) : self

Parameters

$load_test : bool|null: load_test

Return values

self —

setMaxAutomatedInboxPlacementSchedules()

Sets max_automated_inbox_placement_schedules


    public
                    setMaxAutomatedInboxPlacementSchedules(int $max_automated_inbox_placement_schedules) : self

Parameters

$max_automated_inbox_placement_schedules : int: Maximum non-deleted automated inbox placement schedules. Paused schedules count; deleted schedules release capacity.

Return values

self —

setMaxEmailSizeMb()

Sets max_email_size_mb


    public
                    setMaxEmailSizeMb(int $max_email_size_mb) : self

Parameters

$max_email_size_mb : int: max_email_size_mb

Return values

self —

setMaxInboxPlacementSeedAddressesPerTest()

Sets max_inbox_placement_seed_addresses_per_test


    public
                    setMaxInboxPlacementSeedAddressesPerTest(int $max_inbox_placement_seed_addresses_per_test) : self

Parameters

$max_inbox_placement_seed_addresses_per_test : int: Maximum seed inbox addresses assigned to one inbox placement test.

Return values

self —

setMaxUniqueRecipients()

Sets max_unique_recipients


    public
                    setMaxUniqueRecipients(int $max_unique_recipients) : self

Parameters

$max_unique_recipients : int: max_unique_recipients

Return values

self —

setMembers()

Sets members


    public
                    setMembers(int $members) : self

Parameters

$members : int: members

Return values

self —

setMetered()

Sets metered


    public
                    setMetered(bool $metered) : self

Parameters

$metered : bool: metered

Return values

self —

setMonthlyGetMailServerRecords()

Sets monthly_get_mail_server_records


    public
                    setMonthlyGetMailServerRecords(int $monthly_get_mail_server_records) : self

Parameters

$monthly_get_mail_server_records : int: monthly_get_mail_server_records

Return values

self —

setMonthlyInboxes()

Sets monthly_inboxes


    public
                    setMonthlyInboxes(int $monthly_inboxes) : self

Parameters

$monthly_inboxes : int: monthly_inboxes

Return values

self —

setMonthlyReceive()

Sets monthly_receive


    public
                    setMonthlyReceive(int $monthly_receive) : self

Parameters

$monthly_receive : int: monthly_receive

Return values

self —

setMonthlySend()

Sets monthly_send


    public
                    setMonthlySend(int $monthly_send) : self

Parameters

$monthly_send : int: monthly_send

Return values

self —

setMonthlyTemporaryInboxes()

Sets monthly_temporary_inboxes


    public
                    setMonthlyTemporaryInboxes(int|null $monthly_temporary_inboxes) : self

Parameters

$monthly_temporary_inboxes : int|null: monthly_temporary_inboxes

Return values

self —

setMonthlyVerifyEmailAddress()

Sets monthly_verify_email_address


    public
                    setMonthlyVerifyEmailAddress(int $monthly_verify_email_address) : self

Parameters

$monthly_verify_email_address : int: monthly_verify_email_address

Return values

self —

setOauthConnections()

Sets oauth_connections


    public
                    setOauthConnections(int $oauth_connections) : self

Parameters

$oauth_connections : int: oauth_connections

Return values

self —

setOidcSso()

Sets oidc_sso


    public
                    setOidcSso(bool|null $oidc_sso) : self

Parameters

$oidc_sso : bool|null: oidc_sso

Return values

self —

setOrganizations()

Sets organizations


    public
                    setOrganizations(int|null $organizations) : self

Parameters

$organizations : int|null: organizations

Return values

self —

setPassword()

Sets password


    public
                    setPassword(bool $password) : self

Parameters

$password : bool: password

Return values

self —

setPermanentInbox()

Sets permanent_inbox


    public
                    setPermanentInbox(bool $permanent_inbox) : self

Parameters

$permanent_inbox : bool: permanent_inbox

Return values

self —

setPermitsExternalSend()

Sets permits_external_send


    public
                    setPermitsExternalSend(bool|null $permits_external_send) : self

Parameters

$permits_external_send : bool|null: permits_external_send

Return values

self —

setPhoneNumbers()

Sets phone_numbers


    public
                    setPhoneNumbers(int $phone_numbers) : self

Parameters

$phone_numbers : int: phone_numbers

Return values

self —

setPhoneProvisionRequestLimit()

Sets phone_provision_request_limit


    public
                    setPhoneProvisionRequestLimit(int $phone_provision_request_limit) : self

Parameters

$phone_provision_request_limit : int: phone_provision_request_limit

Return values

self —

setRecipients()

Sets recipients


    public
                    setRecipients(int $recipients) : self

Parameters

$recipients : int: recipients

Return values

self —

setSamlSso()

Sets saml_sso


    public
                    setSamlSso(bool|null $saml_sso) : self

Parameters

$saml_sso : bool|null: saml_sso

Return values

self —

setScimProvisioning()

Sets scim_provisioning


    public
                    setScimProvisioning(bool|null $scim_provisioning) : self

Parameters

$scim_provisioning : bool|null: scim_provisioning

Return values

self —

setScreenshots()

Sets screenshots


    public
                    setScreenshots(bool|null $screenshots) : self

Parameters

$screenshots : bool|null: screenshots

Return values

self —

setSendWithQueue()

Sets send_with_queue


    public
                    setSendWithQueue(bool|null $send_with_queue) : self

Parameters

$send_with_queue : bool|null: send_with_queue

Return values

self —

setStorageBytes()

Sets storage_bytes


    public
                    setStorageBytes(int $storage_bytes) : self

Parameters

$storage_bytes : int: storage_bytes

Return values

self —

setSubscriptionId()

Sets subscription_id


    public
                    setSubscriptionId(string|null $subscription_id) : self

Parameters

$subscription_id : string|null: subscription_id

Return values

self —

setSubscriptionSchedule()

Sets subscription_schedule


    public
                    setSubscriptionSchedule(string $subscription_schedule) : self

Parameters

$subscription_schedule : string: subscription_schedule

Return values

self —

setSubscriptionStatus()

Sets subscription_status


    public
                    setSubscriptionStatus(string|null $subscription_status) : self

Parameters

$subscription_status : string|null: subscription_status

Return values

self —

setSubscriptionStatusIsBad()

Sets subscription_status_is_bad


    public
                    setSubscriptionStatusIsBad(bool $subscription_status_is_bad) : self

Parameters

$subscription_status_is_bad : bool: subscription_status_is_bad

Return values

self —

setSubscriptionType()

Sets subscription_type


    public
                    setSubscriptionType(string $subscription_type) : self

Parameters

$subscription_type : string: subscription_type

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

setThreads()

Sets threads


    public
                    setThreads(int $threads) : self

Parameters

$threads : int: threads

Return values

self —

setTotalInboxes()

Sets total_inboxes


    public
                    setTotalInboxes(int $total_inboxes) : self

Parameters

$total_inboxes : int: total_inboxes

Return values

self —

setTotalPermanentInboxes()

Sets total_permanent_inboxes


    public
                    setTotalPermanentInboxes(int|null $total_permanent_inboxes) : self

Parameters

$total_permanent_inboxes : int|null: total_permanent_inboxes

Return values

self —

setTrackingPixels()

Sets tracking_pixels


    public
                    setTrackingPixels(bool $tracking_pixels) : self

Parameters

$tracking_pixels : bool: tracking_pixels

Return values

self —

setTrialAdjustedAt()

Sets trial_adjusted_at


    public
                    setTrialAdjustedAt(DateTime|null $trial_adjusted_at) : self

Parameters

$trial_adjusted_at : DateTime|null: trial_adjusted_at

Return values

self —

setTrialAdjustmentReason()

Sets trial_adjustment_reason


    public
                    setTrialAdjustmentReason(string|null $trial_adjustment_reason) : self

Parameters

$trial_adjustment_reason : string|null: trial_adjustment_reason

Return values

self —

setTrialDays()

Sets trial_days


    public
                    setTrialDays(int|null $trial_days) : self

Parameters

$trial_days : int|null: trial_days

Return values

self —

setTrialEnd()

Sets trial_end


    public
                    setTrialEnd(DateTime|null $trial_end) : self

Parameters

$trial_end : DateTime|null: trial_end

Return values

self —

setTrialStart()

Sets trial_start


    public
                    setTrialStart(DateTime|null $trial_start) : self

Parameters

$trial_start : DateTime|null: trial_start

Return values

self —

setUpdatedAt()

Sets updated_at


    public
                    setUpdatedAt(DateTime $updated_at) : self

Parameters

$updated_at : DateTime: updated_at

Return values

self —

setUserId()

Sets user_id


    public
                    setUserId(string $user_id) : self

Parameters

$user_id : string: user_id

Return values

self —

setUserPermissions()

Sets user_permissions


    public
                    setUserPermissions(bool|null $user_permissions) : self

Parameters

$user_permissions : bool|null: user_permissions

Return values

self —

setVirtualTotpDevices()

Sets virtual_totp_devices


    public
                    setVirtualTotpDevices(bool|null $virtual_totp_devices) : self

Parameters

$virtual_totp_devices : bool|null: virtual_totp_devices

Return values

self —

setWarmupControlledRecipientCreditWeight()

Sets warmup_controlled_recipient_credit_weight


    public
                    setWarmupControlledRecipientCreditWeight(int $warmup_controlled_recipient_credit_weight) : self

Parameters

$warmup_controlled_recipient_credit_weight : int: warmup_controlled_recipient_credit_weight

Return values

self —

setWarmupPremiumRecipientCreditWeight()

Sets warmup_premium_recipient_credit_weight


    public
                    setWarmupPremiumRecipientCreditWeight(int $warmup_premium_recipient_credit_weight) : self

Parameters

$warmup_premium_recipient_credit_weight : int: warmup_premium_recipient_credit_weight

Return values

self —

setWarmupPremiumSeedAccess()

Sets warmup_premium_seed_access


    public
                    setWarmupPremiumSeedAccess(bool|null $warmup_premium_seed_access) : self

Parameters

$warmup_premium_seed_access : bool|null: warmup_premium_seed_access

Return values

self —

setWebhooks()

Sets webhooks


    public
                    setWebhooks(bool $webhooks) : self

Parameters

$webhooks : bool: webhooks

Return values

self —

setZapier()

Sets zapier


    public
                    setZapier(bool $zapier) : self

Parameters

$zapier : bool: zapier

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 —

AccountDtoSubscription in package MailSlurp implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

CURRENCY_AUD

CURRENCY_CAD

CURRENCY_CHF

CURRENCY_CNY

CURRENCY_EUR

CURRENCY_GBP

CURRENCY_INR

CURRENCY_JPY

CURRENCY_NZD

CURRENCY_USD

DISCRIMINATOR

SUBSCRIPTION_SCHEDULE_MONTHLY

SUBSCRIPTION_SCHEDULE_YEARLY

SUBSCRIPTION_STATUS_ACTIVE

SUBSCRIPTION_STATUS_CANCELED

SUBSCRIPTION_STATUS_INCOMPLETE

SUBSCRIPTION_STATUS_INCOMPLETE_EXPIRED

SUBSCRIPTION_STATUS_PAST_DUE

SUBSCRIPTION_STATUS_PAUSED

SUBSCRIPTION_STATUS_TRIALING

SUBSCRIPTION_STATUS_UNPAID

SUBSCRIPTION_TYPE_ENTERPRISE

SUBSCRIPTION_TYPE_PRO

SUBSCRIPTION_TYPE_PRO_MONTHLY

SUBSCRIPTION_TYPE_STARTER

SUBSCRIPTION_TYPE_TEAM

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAgents()

Return values

getAiDestinationSheets()

Return values

getAiTransformers()

Return values

getAliases()

Return values

getAttachmentAutomations()

Return values

getAttachments()

Return values

getAuditLogs()

Return values

getBackup()

Return values

getBulk()

Return values

getCampaignProbe()

Return values

getCancelAt()

Return values

getContacts()

Return values

getCost()

Return values

getCostMajor()

Return values

getCreatedAt()

Return values

AccountDtoSubscription
in package

MailSlurp

implements ModelInterface, ArrayAccess, JsonSerializable