Documentation

SendingConnectionProviderDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

SendingConnectionProviderDto Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

AVAILABILITY_AVAILABLE  = 'AVAILABLE'
AVAILABILITY_PLANNED  = 'PLANNED'
CAPABILITIES_DELIVERY_PROBE  = 'DELIVERY_PROBE'
CAPABILITIES_ROTATE_CREDENTIALS  = 'ROTATE_CREDENTIALS'
CAPABILITIES_SEND_EMAIL  = 'SEND_EMAIL'
CAPABILITIES_VERIFY_CONNECTION  = 'VERIFY_CONNECTION'
CATEGORY_CUSTOM  = 'CUSTOM'
CATEGORY_MAILBOX  = 'MAILBOX'
CATEGORY_TRANSACTIONAL  = 'TRANSACTIONAL'
DISCRIMINATOR  = null
PROVIDER_AMAZON_SES  = 'AMAZON_SES'
PROVIDER_MAILGUN  = 'MAILGUN'
PROVIDER_POSTMARK  = 'POSTMARK'
PROVIDER_PRESET_AMAZON_SES  = 'AMAZON_SES'
PROVIDER_PRESET_AOL_MAIL  = 'AOL_MAIL'
PROVIDER_PRESET_APPLE_ICLOUD  = 'APPLE_ICLOUD'
PROVIDER_PRESET_BREVO  = 'BREVO'
PROVIDER_PRESET_ELASTIC_EMAIL  = 'ELASTIC_EMAIL'
PROVIDER_PRESET_FASTMAIL  = 'FASTMAIL'
PROVIDER_PRESET_GENERIC_SMTP  = 'GENERIC_SMTP'
PROVIDER_PRESET_GMAIL  = 'GMAIL'
PROVIDER_PRESET_GMX_MAIL  = 'GMX_MAIL'
PROVIDER_PRESET_GOOGLE_WORKSPACE  = 'GOOGLE_WORKSPACE'
PROVIDER_PRESET_MAIL_COM  = 'MAIL_COM'
PROVIDER_PRESET_MAILERSEND  = 'MAILERSEND'
PROVIDER_PRESET_MAILGUN  = 'MAILGUN'
PROVIDER_PRESET_MAILJET  = 'MAILJET'
PROVIDER_PRESET_MANDRILL  = 'MANDRILL'
PROVIDER_PRESET_MICROSOFT_365  = 'MICROSOFT_365'
PROVIDER_PRESET_OUTLOOK_COM  = 'OUTLOOK_COM'
PROVIDER_PRESET_POSTMARK  = 'POSTMARK'
PROVIDER_PRESET_PROTON_MAIL  = 'PROTON_MAIL'
PROVIDER_PRESET_RESEND  = 'RESEND'
PROVIDER_PRESET_SENDGRID  = 'SENDGRID'
PROVIDER_PRESET_SENDPULSE  = 'SENDPULSE'
PROVIDER_PRESET_SMTP2_GO  = 'SMTP2GO'
PROVIDER_PRESET_SOCKETLABS  = 'SOCKETLABS'
PROVIDER_PRESET_SPARKPOST  = 'SPARKPOST'
PROVIDER_PRESET_YAHOO_MAIL  = 'YAHOO_MAIL'
PROVIDER_PRESET_ZOHO_MAIL  = 'ZOHO_MAIL'
PROVIDER_RESEND  = 'RESEND'
PROVIDER_SENDGRID  = 'SENDGRID'
PROVIDER_SMTP  = 'SMTP'
SETUP_TYPE_API_KEY  = 'API_KEY'
SETUP_TYPE_AWS_CREDENTIALS  = 'AWS_CREDENTIALS'
SETUP_TYPE_OAUTH  = 'OAUTH'
SETUP_TYPE_SMTP  = 'SMTP'
SETUP_TYPE_UNAVAILABLE  = 'UNAVAILABLE'
SUPPORTED_API_REGIONS_EU  = 'EU'
SUPPORTED_API_REGIONS_US  = 'US'
$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
getAvailability()  : string
Gets availability
getAvailabilityAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCapabilities()  : array<string|int, string>
Gets capabilities
getCapabilitiesAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCategory()  : string
Gets category
getCategoryAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCredentialType()  : string
Gets credential_type
getDisplayName()  : string
Gets display_name
getModelName()  : string
The original name of the model.
getNativeIntegration()  : bool
Gets native_integration
getProvider()  : string
Gets provider
getProviderAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getProviderPreset()  : string
Gets provider_preset
getProviderPresetAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getRequiresSendingDomain()  : bool
Gets requires_sending_domain
getSetupNotes()  : array<string|int, string>
Gets setup_notes
getSetupType()  : string
Gets setup_type
getSetupTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSmtpDefaults()  : SendingConnectionProviderDtoSmtpDefaults|null
Gets smtp_defaults
getSupportedApiRegions()  : array<string|int, string>
Gets supported_api_regions
getSupportedApiRegionsAllowableValues()  : 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)
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
setAvailability()  : self
Sets availability
setCapabilities()  : self
Sets capabilities
setCategory()  : self
Sets category
setCredentialType()  : self
Sets credential_type
setDisplayName()  : self
Sets display_name
setNativeIntegration()  : self
Sets native_integration
setProvider()  : self
Sets provider
setProviderPreset()  : self
Sets provider_preset
setRequiresSendingDomain()  : self
Sets requires_sending_domain
setSetupNotes()  : self
Sets setup_notes
setSetupType()  : self
Sets setup_type
setSmtpDefaults()  : self
Sets smtp_defaults
setSupportedApiRegions()  : self
Sets supported_api_regions
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
toHeaderValue()  : string
Gets a header-safe presentation of the object
valid()  : bool
Validate all the properties in the model return true if all passed
openAPINullables()  : array<string|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['provider_preset' => 'providerPreset', 'provider' => 'provider', 'display_name' => 'displayName', 'category' => 'category', 'availability' => 'availability', 'setup_type' => 'setupType', 'native_integration' => 'nativeIntegration', 'smtp_defaults' => 'smtpDefaults', 'supported_api_regions' => 'supportedApiRegions', 'requires_sending_domain' => 'requiresSendingDomain', 'setup_notes' => 'setupNotes', 'credential_type' => 'credentialType', 'capabilities' => 'capabilities']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['provider_preset' => 'getProviderPreset', 'provider' => 'getProvider', 'display_name' => 'getDisplayName', 'category' => 'getCategory', 'availability' => 'getAvailability', 'setup_type' => 'getSetupType', 'native_integration' => 'getNativeIntegration', 'smtp_defaults' => 'getSmtpDefaults', 'supported_api_regions' => 'getSupportedApiRegions', 'requires_sending_domain' => 'getRequiresSendingDomain', 'setup_notes' => 'getSetupNotes', 'credential_type' => 'getCredentialType', 'capabilities' => 'getCapabilities']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['provider_preset' => null, 'provider' => null, 'display_name' => null, 'category' => null, 'availability' => null, 'setup_type' => null, 'native_integration' => null, 'smtp_defaults' => null, 'supported_api_regions' => null, 'requires_sending_domain' => null, 'setup_notes' => null, 'credential_type' => null, 'capabilities' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'SendingConnectionProviderDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['provider_preset' => false, 'provider' => false, 'display_name' => false, 'category' => false, 'availability' => false, 'setup_type' => false, 'native_integration' => false, 'smtp_defaults' => true, 'supported_api_regions' => false, 'requires_sending_domain' => false, 'setup_notes' => false, 'credential_type' => false, 'capabilities' => 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 = ['provider_preset' => 'string', 'provider' => 'string', 'display_name' => 'string', 'category' => 'string', 'availability' => 'string', 'setup_type' => 'string', 'native_integration' => 'bool', 'smtp_defaults' => '\\MailSlurp\\Models\\SendingConnectionProviderDtoSmtpDefaults', 'supported_api_regions' => 'string[]', 'requires_sending_domain' => 'bool', 'setup_notes' => 'string[]', 'credential_type' => 'string', 'capabilities' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['provider_preset' => 'setProviderPreset', 'provider' => 'setProvider', 'display_name' => 'setDisplayName', 'category' => 'setCategory', 'availability' => 'setAvailability', 'setup_type' => 'setSetupType', 'native_integration' => 'setNativeIntegration', 'smtp_defaults' => 'setSmtpDefaults', 'supported_api_regions' => 'setSupportedApiRegions', 'requires_sending_domain' => 'setRequiresSendingDomain', 'setup_notes' => 'setSetupNotes', 'credential_type' => 'setCredentialType', 'capabilities' => 'setCapabilities']

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 —

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

getAvailabilityAllowableValues()

Gets allowable values of the enum

public getAvailabilityAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getCapabilities()

Gets capabilities

public getCapabilities() : array<string|int, string>
Return values
array<string|int, string> —

getCapabilitiesAllowableValues()

Gets allowable values of the enum

public getCapabilitiesAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getCategoryAllowableValues()

Gets allowable values of the enum

public getCategoryAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getProviderAllowableValues()

Gets allowable values of the enum

public getProviderAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getProviderPresetAllowableValues()

Gets allowable values of the enum

public getProviderPresetAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getRequiresSendingDomain()

Gets requires_sending_domain

public getRequiresSendingDomain() : bool
Return values
bool —

getSetupNotes()

Gets setup_notes

public getSetupNotes() : array<string|int, string>
Return values
array<string|int, string> —

getSetupTypeAllowableValues()

Gets allowable values of the enum

public getSetupTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getSupportedApiRegions()

Gets supported_api_regions

public getSupportedApiRegions() : array<string|int, string>
Return values
array<string|int, string> —

getSupportedApiRegionsAllowableValues()

Gets allowable values of the enum

public getSupportedApiRegionsAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

isNullable()

Checks if a property is nullable

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool —

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed|null
Parameters
$offset : int

Offset

Return values
mixed|null —

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

openAPIFormats()

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

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

openAPITypes()

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

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setAvailability()

Sets availability

public setAvailability(string $availability) : self
Parameters
$availability : string

availability

Return values
self —

setCapabilities()

Sets capabilities

public setCapabilities(array<string|int, string> $capabilities) : self
Parameters
$capabilities : array<string|int, string>

capabilities

Return values
self —

setCategory()

Sets category

public setCategory(string $category) : self
Parameters
$category : string

category

Return values
self —

setCredentialType()

Sets credential_type

public setCredentialType(string $credential_type) : self
Parameters
$credential_type : string

credential_type

Return values
self —

setDisplayName()

Sets display_name

public setDisplayName(string $display_name) : self
Parameters
$display_name : string

display_name

Return values
self —

setNativeIntegration()

Sets native_integration

public setNativeIntegration(bool $native_integration) : self
Parameters
$native_integration : bool

native_integration

Return values
self —

setProvider()

Sets provider

public setProvider(string $provider) : self
Parameters
$provider : string

provider

Return values
self —

setProviderPreset()

Sets provider_preset

public setProviderPreset(string $provider_preset) : self
Parameters
$provider_preset : string

provider_preset

Return values
self —

setRequiresSendingDomain()

Sets requires_sending_domain

public setRequiresSendingDomain(bool $requires_sending_domain) : self
Parameters
$requires_sending_domain : bool

requires_sending_domain

Return values
self —

setSetupNotes()

Sets setup_notes

public setSetupNotes(array<string|int, string> $setup_notes) : self
Parameters
$setup_notes : array<string|int, string>

setup_notes

Return values
self —

setSetupType()

Sets setup_type

public setSetupType(string $setup_type) : self
Parameters
$setup_type : string

setup_type

Return values
self —

setSupportedApiRegions()

Sets supported_api_regions

public setSupportedApiRegions(array<string|int, string> $supported_api_regions) : self
Parameters
$supported_api_regions : array<string|int, string>

supported_api_regions

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

toHeaderValue()

Gets a header-safe presentation of the object

public toHeaderValue() : string
Return values
string —

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

openAPINullables()

Array of nullable properties

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed
Return values
void —

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
Return values
void —

Search results