AgentCapabilitiesDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AgentCapabilitiesDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- ROLE_DRAFT_ONLY = 'AGENT_DRAFT_ONLY'
- ROLE_INBOX_MANAGER = 'AGENT_INBOX_MANAGER'
- ROLE_READ_ONLY = 'AGENT_READ_ONLY'
- ROLE_RESPONDER = 'AGENT_RESPONDER'
- ROLE_SUPPORT = 'AGENT_SUPPORT'
- ROLE_TOTP_MANAGER = 'AGENT_TOTP_MANAGER'
- $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
- getAccountId() : string
- Gets account_id
- getApiVersion() : string
- Gets api_version
- getConnectionId() : string
- Gets connection_id
- getFeatures() : AgentCapabilityFeaturesDto
- Gets features
- getLimits() : AgentCapabilityLimitsDto
- Gets limits
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getPermissions() : array<string|int, string>
- Gets permissions
- getRole() : string
- Gets role
- getRoleAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getScope() : AgentCapabilityScopeDto
- Gets scope
- 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
- setAccountId() : self
- Sets account_id
- setApiVersion() : self
- Sets api_version
- setConnectionId() : self
- Sets connection_id
- setFeatures() : self
- Sets features
- setLimits() : self
- Sets limits
- setName() : self
- Sets name
- setPermissions() : self
- Sets permissions
- setRole() : self
- Sets role
- setScope() : self
- Sets scope
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
ROLE_DRAFT_ONLY
public
mixed
ROLE_DRAFT_ONLY
= 'AGENT_DRAFT_ONLY'
ROLE_INBOX_MANAGER
public
mixed
ROLE_INBOX_MANAGER
= 'AGENT_INBOX_MANAGER'
ROLE_READ_ONLY
public
mixed
ROLE_READ_ONLY
= 'AGENT_READ_ONLY'
ROLE_RESPONDER
public
mixed
ROLE_RESPONDER
= 'AGENT_RESPONDER'
ROLE_SUPPORT
public
mixed
ROLE_SUPPORT
= 'AGENT_SUPPORT'
ROLE_TOTP_MANAGER
public
mixed
ROLE_TOTP_MANAGER
= 'AGENT_TOTP_MANAGER'
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
= ['connection_id' => 'connectionId', 'account_id' => 'accountId', 'name' => 'name', 'role' => 'role', 'permissions' => 'permissions', 'scope' => 'scope', 'features' => 'features', 'limits' => 'limits', 'api_version' => 'apiVersion']
$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
= ['connection_id' => 'getConnectionId', 'account_id' => 'getAccountId', 'name' => 'getName', 'role' => 'getRole', 'permissions' => 'getPermissions', 'scope' => 'getScope', 'features' => 'getFeatures', 'limits' => 'getLimits', 'api_version' => 'getApiVersion']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['connection_id' => 'uuid', 'account_id' => 'uuid', 'name' => null, 'role' => null, 'permissions' => null, 'scope' => null, 'features' => null, 'limits' => null, 'api_version' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AgentCapabilitiesDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['connection_id' => false, 'account_id' => false, 'name' => false, 'role' => false, 'permissions' => false, 'scope' => false, 'features' => false, 'limits' => false, 'api_version' => 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
= ['connection_id' => 'string', 'account_id' => 'string', 'name' => 'string', 'role' => 'string', 'permissions' => 'string[]', 'scope' => '\\MailSlurp\\Models\\AgentCapabilityScopeDto', 'features' => '\\MailSlurp\\Models\\AgentCapabilityFeaturesDto', 'limits' => '\\MailSlurp\\Models\\AgentCapabilityLimitsDto', 'api_version' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['connection_id' => 'setConnectionId', 'account_id' => 'setAccountId', 'name' => 'setName', 'role' => 'setRole', 'permissions' => 'setPermissions', 'scope' => 'setScope', 'features' => 'setFeatures', 'limits' => 'setLimits', 'api_version' => 'setApiVersion']
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> —getAccountId()
Gets account_id
public
getAccountId() : string
Return values
string —getApiVersion()
Gets api_version
public
getApiVersion() : string
Return values
string —getConnectionId()
Gets connection_id
public
getConnectionId() : string
Return values
string —getFeatures()
Gets features
public
getFeatures() : AgentCapabilityFeaturesDto
Return values
AgentCapabilityFeaturesDto —getLimits()
Gets limits
public
getLimits() : AgentCapabilityLimitsDto
Return values
AgentCapabilityLimitsDto —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getPermissions()
Gets permissions
public
getPermissions() : array<string|int, string>
Return values
array<string|int, string> —getRole()
Gets role
public
getRole() : string
Return values
string —getRoleAllowableValues()
Gets allowable values of the enum
public
getRoleAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getScope()
Gets scope
public
getScope() : AgentCapabilityScopeDto
Return values
AgentCapabilityScopeDto —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> —setAccountId()
Sets account_id
public
setAccountId(string $account_id) : self
Parameters
- $account_id : string
-
account_id
Return values
self —setApiVersion()
Sets api_version
public
setApiVersion(string $api_version) : self
Parameters
- $api_version : string
-
api_version
Return values
self —setConnectionId()
Sets connection_id
public
setConnectionId(string $connection_id) : self
Parameters
- $connection_id : string
-
connection_id
Return values
self —setFeatures()
Sets features
public
setFeatures(AgentCapabilityFeaturesDto $features) : self
Parameters
- $features : AgentCapabilityFeaturesDto
-
features
Return values
self —setLimits()
Sets limits
public
setLimits(AgentCapabilityLimitsDto $limits) : self
Parameters
- $limits : AgentCapabilityLimitsDto
-
limits
Return values
self —setName()
Sets name
public
setName(string $name) : self
Parameters
- $name : string
-
name
Return values
self —setPermissions()
Sets permissions
public
setPermissions(array<string|int, string> $permissions) : self
Parameters
- $permissions : array<string|int, string>
-
permissions
Return values
self —setRole()
Sets role
public
setRole(string $role) : self
Parameters
- $role : string
-
role
Return values
self —setScope()
Sets scope
public
setScope(AgentCapabilityScopeDto $scope) : self
Parameters
- $scope : AgentCapabilityScopeDto
-
scope
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>