CreateConnectorOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateConnectorOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- CONNECTOR_AUTH_TYPE_PLAIN_TEXT = 'PLAIN_TEXT'
- CONNECTOR_TYPE_IMAP = 'IMAP'
- DISCRIMINATOR = null
- SYNC_SCHEDULE_TYPE_INTERVAL = 'INTERVAL'
- $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
- getConnectorAuthType() : string
- Gets connector_auth_type
- getConnectorAuthTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getConnectorType() : string
- Gets connector_type
- getConnectorTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getImapSettings() : CreateConnectorImapOptions|null
- Gets imap_settings
- getInboxId() : string|null
- Gets inbox_id
- getModelName() : string
- The original name of the model.
- getSyncEnabled() : bool
- Gets sync_enabled
- getSyncInterval() : int|null
- Gets sync_interval
- getSyncScheduleType() : string
- Gets sync_schedule_type
- getSyncScheduleTypeAllowableValues() : 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
- setConnectorAuthType() : self
- Sets connector_auth_type
- setConnectorType() : self
- Sets connector_type
- setImapSettings() : self
- Sets imap_settings
- setInboxId() : self
- Sets inbox_id
- setSyncEnabled() : self
- Sets sync_enabled
- setSyncInterval() : self
- Sets sync_interval
- setSyncScheduleType() : self
- Sets sync_schedule_type
- 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
CONNECTOR_AUTH_TYPE_PLAIN_TEXT
public
mixed
CONNECTOR_AUTH_TYPE_PLAIN_TEXT
= 'PLAIN_TEXT'
CONNECTOR_TYPE_IMAP
public
mixed
CONNECTOR_TYPE_IMAP
= 'IMAP'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
SYNC_SCHEDULE_TYPE_INTERVAL
public
mixed
SYNC_SCHEDULE_TYPE_INTERVAL
= 'INTERVAL'
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
= ['connector_type' => 'connectorType', 'connector_auth_type' => 'connectorAuthType', 'imap_settings' => 'imapSettings', 'inbox_id' => 'inboxId', 'sync_enabled' => 'syncEnabled', 'sync_schedule_type' => 'syncScheduleType', 'sync_interval' => 'syncInterval']
$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
= ['connector_type' => 'getConnectorType', 'connector_auth_type' => 'getConnectorAuthType', 'imap_settings' => 'getImapSettings', 'inbox_id' => 'getInboxId', 'sync_enabled' => 'getSyncEnabled', 'sync_schedule_type' => 'getSyncScheduleType', 'sync_interval' => 'getSyncInterval']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['connector_type' => null, 'connector_auth_type' => null, 'imap_settings' => null, 'inbox_id' => 'uuid', 'sync_enabled' => null, 'sync_schedule_type' => null, 'sync_interval' => 'int32']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateConnectorOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['connector_type' => false, 'connector_auth_type' => false, 'imap_settings' => false, 'inbox_id' => false, 'sync_enabled' => false, 'sync_schedule_type' => false, 'sync_interval' => 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
= ['connector_type' => 'string', 'connector_auth_type' => 'string', 'imap_settings' => '\\MailSlurp\\Models\\CreateConnectorImapOptions', 'inbox_id' => 'string', 'sync_enabled' => 'bool', 'sync_schedule_type' => 'string', 'sync_interval' => 'int']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['connector_type' => 'setConnectorType', 'connector_auth_type' => 'setConnectorAuthType', 'imap_settings' => 'setImapSettings', 'inbox_id' => 'setInboxId', 'sync_enabled' => 'setSyncEnabled', 'sync_schedule_type' => 'setSyncScheduleType', 'sync_interval' => 'setSyncInterval']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getConnectorAuthType()
Gets connector_auth_type
public
getConnectorAuthType() : string
Return values
string —getConnectorAuthTypeAllowableValues()
Gets allowable values of the enum
public
getConnectorAuthTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getConnectorType()
Gets connector_type
public
getConnectorType() : string
Return values
string —getConnectorTypeAllowableValues()
Gets allowable values of the enum
public
getConnectorTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getImapSettings()
Gets imap_settings
public
getImapSettings() : CreateConnectorImapOptions|null
Return values
CreateConnectorImapOptions|null —getInboxId()
Gets inbox_id
public
getInboxId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSyncEnabled()
Gets sync_enabled
public
getSyncEnabled() : bool
Return values
bool —getSyncInterval()
Gets sync_interval
public
getSyncInterval() : int|null
Return values
int|null —getSyncScheduleType()
Gets sync_schedule_type
public
getSyncScheduleType() : string
Return values
string —getSyncScheduleTypeAllowableValues()
Gets allowable values of the enum
public
getSyncScheduleTypeAllowableValues() : 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 —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setConnectorAuthType()
Sets connector_auth_type
public
setConnectorAuthType(string $connector_auth_type) : self
Parameters
- $connector_auth_type : string
-
connector_auth_type
Return values
self —setConnectorType()
Sets connector_type
public
setConnectorType(string $connector_type) : self
Parameters
- $connector_type : string
-
connector_type
Return values
self —setImapSettings()
Sets imap_settings
public
setImapSettings(CreateConnectorImapOptions|null $imap_settings) : self
Parameters
- $imap_settings : CreateConnectorImapOptions|null
-
imap_settings
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
inbox_id
Return values
self —setSyncEnabled()
Sets sync_enabled
public
setSyncEnabled(bool $sync_enabled) : self
Parameters
- $sync_enabled : bool
-
sync_enabled
Return values
self —setSyncInterval()
Sets sync_interval
public
setSyncInterval(int|null $sync_interval) : self
Parameters
- $sync_interval : int|null
-
sync_interval
Return values
self —setSyncScheduleType()
Sets sync_schedule_type
public
setSyncScheduleType(string $sync_schedule_type) : self
Parameters
- $sync_schedule_type : string
-
sync_schedule_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> —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>