AgentActivityDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AgentActivityDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- AGENT_ROLE_DRAFT_ONLY = 'AGENT_DRAFT_ONLY'
- AGENT_ROLE_INBOX_MANAGER = 'AGENT_INBOX_MANAGER'
- AGENT_ROLE_READ_ONLY = 'AGENT_READ_ONLY'
- AGENT_ROLE_RESPONDER = 'AGENT_RESPONDER'
- AGENT_ROLE_SUPPORT = 'AGENT_SUPPORT'
- AGENT_ROLE_TOTP_MANAGER = 'AGENT_TOTP_MANAGER'
- DISCRIMINATOR = null
- EVENT_TYPE_ADD_SMS_CONVERSATION_NOTE = 'ADD_SMS_CONVERSATION_NOTE'
- EVENT_TYPE_CLAIM_SMS_CONVERSATION = 'CLAIM_SMS_CONVERSATION'
- EVENT_TYPE_CREATE_EMAIL_DRAFT = 'CREATE_EMAIL_DRAFT'
- EVENT_TYPE_CREATE_TOTP_DEVICE = 'CREATE_TOTP_DEVICE'
- EVENT_TYPE_DELETE_EMAIL_DRAFT = 'DELETE_EMAIL_DRAFT'
- EVENT_TYPE_DELETE_TOTP_DEVICE = 'DELETE_TOTP_DEVICE'
- EVENT_TYPE_GENERATE_TOTP_CODE = 'GENERATE_TOTP_CODE'
- EVENT_TYPE_GET_EMAIL = 'GET_EMAIL'
- EVENT_TYPE_GET_EMAIL_DRAFT = 'GET_EMAIL_DRAFT'
- EVENT_TYPE_GET_EMAIL_SUMMARY = 'GET_EMAIL_SUMMARY'
- EVENT_TYPE_GET_LATEST_INBOX_EMAIL = 'GET_LATEST_INBOX_EMAIL'
- EVENT_TYPE_GET_PHONE_NUMBER = 'GET_PHONE_NUMBER'
- EVENT_TYPE_GET_RECEIVED_SMS = 'GET_RECEIVED_SMS'
- EVENT_TYPE_GET_SENT_SMS = 'GET_SENT_SMS'
- EVENT_TYPE_GET_SMS_CONVERSATION = 'GET_SMS_CONVERSATION'
- EVENT_TYPE_GET_TOTP_DEVICE = 'GET_TOTP_DEVICE'
- EVENT_TYPE_LIST_EMAIL_DRAFTS = 'LIST_EMAIL_DRAFTS'
- EVENT_TYPE_LIST_INBOX_EMAILS = 'LIST_INBOX_EMAILS'
- EVENT_TYPE_LIST_PHONE_MESSAGE_THREAD_ITEMS = 'LIST_PHONE_MESSAGE_THREAD_ITEMS'
- EVENT_TYPE_LIST_PHONE_MESSAGE_THREADS = 'LIST_PHONE_MESSAGE_THREADS'
- EVENT_TYPE_LIST_PHONE_NUMBERS = 'LIST_PHONE_NUMBERS'
- EVENT_TYPE_LIST_RECEIVED_SMS = 'LIST_RECEIVED_SMS'
- EVENT_TYPE_LIST_SENT_SMS = 'LIST_SENT_SMS'
- EVENT_TYPE_LIST_SMS_CONVERSATIONS = 'LIST_SMS_CONVERSATIONS'
- EVENT_TYPE_LIST_TOTP_DEVICES = 'LIST_TOTP_DEVICES'
- EVENT_TYPE_REPLY_SMS = 'REPLY_SMS'
- EVENT_TYPE_REPLY_TO_EMAIL = 'REPLY_TO_EMAIL'
- EVENT_TYPE_REQUEST_SMS_CONVERSATION_HANDOFF = 'REQUEST_SMS_CONVERSATION_HANDOFF'
- EVENT_TYPE_SEND_EMAIL_DRAFT = 'SEND_EMAIL_DRAFT'
- EVENT_TYPE_SEND_SMS = 'SEND_SMS'
- EVENT_TYPE_UPDATE_EMAIL_DRAFT = 'UPDATE_EMAIL_DRAFT'
- EVENT_TYPE_UPDATE_TOTP_DEVICE = 'UPDATE_TOTP_DEVICE'
- STATUS_FAILURE = 'FAILURE'
- STATUS_SUCCESS = 'SUCCESS'
- $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
- getActionName() : string|null
- Gets action_name
- getActionRequestId() : string|null
- Gets action_request_id
- getAgentName() : string|null
- Gets agent_name
- getAgentRole() : string|null
- Gets agent_role
- getAgentRoleAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getApiKeyEntityId() : string|null
- Gets api_key_entity_id
- getConversationId() : string|null
- Gets conversation_id
- getCreatedAt() : DateTime
- Gets created_at
- getDraftId() : string|null
- Gets draft_id
- getEmailId() : string|null
- Gets email_id
- getErrorCode() : string|null
- Gets error_code
- getErrorMessage() : string|null
- Gets error_message
- getEventType() : string
- Gets event_type
- getEventTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getId() : string
- Gets id
- getInboxId() : string|null
- Gets inbox_id
- getModelName() : string
- The original name of the model.
- getPhoneNumberId() : string|null
- Gets phone_number_id
- getSentSmsId() : string|null
- Gets sent_sms_id
- getSmsId() : string|null
- Gets sms_id
- getSmsParticipant() : string|null
- Gets sms_participant
- getStatus() : string
- Gets status
- getStatusAllowableValues() : 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)
- getThreadId() : string|null
- Gets thread_id
- getToolName() : string|null
- Gets tool_name
- getUserId() : string
- Gets user_id
- 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
- setActionName() : self
- Sets action_name
- setActionRequestId() : self
- Sets action_request_id
- setAgentName() : self
- Sets agent_name
- setAgentRole() : self
- Sets agent_role
- setApiKeyEntityId() : self
- Sets api_key_entity_id
- setConversationId() : self
- Sets conversation_id
- setCreatedAt() : self
- Sets created_at
- setDraftId() : self
- Sets draft_id
- setEmailId() : self
- Sets email_id
- setErrorCode() : self
- Sets error_code
- setErrorMessage() : self
- Sets error_message
- setEventType() : self
- Sets event_type
- setId() : self
- Sets id
- setInboxId() : self
- Sets inbox_id
- setPhoneNumberId() : self
- Sets phone_number_id
- setSentSmsId() : self
- Sets sent_sms_id
- setSmsId() : self
- Sets sms_id
- setSmsParticipant() : self
- Sets sms_participant
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setThreadId() : self
- Sets thread_id
- setToolName() : self
- Sets tool_name
- setUserId() : self
- Sets user_id
- 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
AGENT_ROLE_DRAFT_ONLY
public
mixed
AGENT_ROLE_DRAFT_ONLY
= 'AGENT_DRAFT_ONLY'
AGENT_ROLE_INBOX_MANAGER
public
mixed
AGENT_ROLE_INBOX_MANAGER
= 'AGENT_INBOX_MANAGER'
AGENT_ROLE_READ_ONLY
public
mixed
AGENT_ROLE_READ_ONLY
= 'AGENT_READ_ONLY'
AGENT_ROLE_RESPONDER
public
mixed
AGENT_ROLE_RESPONDER
= 'AGENT_RESPONDER'
AGENT_ROLE_SUPPORT
public
mixed
AGENT_ROLE_SUPPORT
= 'AGENT_SUPPORT'
AGENT_ROLE_TOTP_MANAGER
public
mixed
AGENT_ROLE_TOTP_MANAGER
= 'AGENT_TOTP_MANAGER'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
EVENT_TYPE_ADD_SMS_CONVERSATION_NOTE
public
mixed
EVENT_TYPE_ADD_SMS_CONVERSATION_NOTE
= 'ADD_SMS_CONVERSATION_NOTE'
EVENT_TYPE_CLAIM_SMS_CONVERSATION
public
mixed
EVENT_TYPE_CLAIM_SMS_CONVERSATION
= 'CLAIM_SMS_CONVERSATION'
EVENT_TYPE_CREATE_EMAIL_DRAFT
public
mixed
EVENT_TYPE_CREATE_EMAIL_DRAFT
= 'CREATE_EMAIL_DRAFT'
EVENT_TYPE_CREATE_TOTP_DEVICE
public
mixed
EVENT_TYPE_CREATE_TOTP_DEVICE
= 'CREATE_TOTP_DEVICE'
EVENT_TYPE_DELETE_EMAIL_DRAFT
public
mixed
EVENT_TYPE_DELETE_EMAIL_DRAFT
= 'DELETE_EMAIL_DRAFT'
EVENT_TYPE_DELETE_TOTP_DEVICE
public
mixed
EVENT_TYPE_DELETE_TOTP_DEVICE
= 'DELETE_TOTP_DEVICE'
EVENT_TYPE_GENERATE_TOTP_CODE
public
mixed
EVENT_TYPE_GENERATE_TOTP_CODE
= 'GENERATE_TOTP_CODE'
EVENT_TYPE_GET_EMAIL
public
mixed
EVENT_TYPE_GET_EMAIL
= 'GET_EMAIL'
EVENT_TYPE_GET_EMAIL_DRAFT
public
mixed
EVENT_TYPE_GET_EMAIL_DRAFT
= 'GET_EMAIL_DRAFT'
EVENT_TYPE_GET_EMAIL_SUMMARY
public
mixed
EVENT_TYPE_GET_EMAIL_SUMMARY
= 'GET_EMAIL_SUMMARY'
EVENT_TYPE_GET_LATEST_INBOX_EMAIL
public
mixed
EVENT_TYPE_GET_LATEST_INBOX_EMAIL
= 'GET_LATEST_INBOX_EMAIL'
EVENT_TYPE_GET_PHONE_NUMBER
public
mixed
EVENT_TYPE_GET_PHONE_NUMBER
= 'GET_PHONE_NUMBER'
EVENT_TYPE_GET_RECEIVED_SMS
public
mixed
EVENT_TYPE_GET_RECEIVED_SMS
= 'GET_RECEIVED_SMS'
EVENT_TYPE_GET_SENT_SMS
public
mixed
EVENT_TYPE_GET_SENT_SMS
= 'GET_SENT_SMS'
EVENT_TYPE_GET_SMS_CONVERSATION
public
mixed
EVENT_TYPE_GET_SMS_CONVERSATION
= 'GET_SMS_CONVERSATION'
EVENT_TYPE_GET_TOTP_DEVICE
public
mixed
EVENT_TYPE_GET_TOTP_DEVICE
= 'GET_TOTP_DEVICE'
EVENT_TYPE_LIST_EMAIL_DRAFTS
public
mixed
EVENT_TYPE_LIST_EMAIL_DRAFTS
= 'LIST_EMAIL_DRAFTS'
EVENT_TYPE_LIST_INBOX_EMAILS
public
mixed
EVENT_TYPE_LIST_INBOX_EMAILS
= 'LIST_INBOX_EMAILS'
EVENT_TYPE_LIST_PHONE_MESSAGE_THREAD_ITEMS
public
mixed
EVENT_TYPE_LIST_PHONE_MESSAGE_THREAD_ITEMS
= 'LIST_PHONE_MESSAGE_THREAD_ITEMS'
EVENT_TYPE_LIST_PHONE_MESSAGE_THREADS
public
mixed
EVENT_TYPE_LIST_PHONE_MESSAGE_THREADS
= 'LIST_PHONE_MESSAGE_THREADS'
EVENT_TYPE_LIST_PHONE_NUMBERS
public
mixed
EVENT_TYPE_LIST_PHONE_NUMBERS
= 'LIST_PHONE_NUMBERS'
EVENT_TYPE_LIST_RECEIVED_SMS
public
mixed
EVENT_TYPE_LIST_RECEIVED_SMS
= 'LIST_RECEIVED_SMS'
EVENT_TYPE_LIST_SENT_SMS
public
mixed
EVENT_TYPE_LIST_SENT_SMS
= 'LIST_SENT_SMS'
EVENT_TYPE_LIST_SMS_CONVERSATIONS
public
mixed
EVENT_TYPE_LIST_SMS_CONVERSATIONS
= 'LIST_SMS_CONVERSATIONS'
EVENT_TYPE_LIST_TOTP_DEVICES
public
mixed
EVENT_TYPE_LIST_TOTP_DEVICES
= 'LIST_TOTP_DEVICES'
EVENT_TYPE_REPLY_SMS
public
mixed
EVENT_TYPE_REPLY_SMS
= 'REPLY_SMS'
EVENT_TYPE_REPLY_TO_EMAIL
public
mixed
EVENT_TYPE_REPLY_TO_EMAIL
= 'REPLY_TO_EMAIL'
EVENT_TYPE_REQUEST_SMS_CONVERSATION_HANDOFF
public
mixed
EVENT_TYPE_REQUEST_SMS_CONVERSATION_HANDOFF
= 'REQUEST_SMS_CONVERSATION_HANDOFF'
EVENT_TYPE_SEND_EMAIL_DRAFT
public
mixed
EVENT_TYPE_SEND_EMAIL_DRAFT
= 'SEND_EMAIL_DRAFT'
EVENT_TYPE_SEND_SMS
public
mixed
EVENT_TYPE_SEND_SMS
= 'SEND_SMS'
EVENT_TYPE_UPDATE_EMAIL_DRAFT
public
mixed
EVENT_TYPE_UPDATE_EMAIL_DRAFT
= 'UPDATE_EMAIL_DRAFT'
EVENT_TYPE_UPDATE_TOTP_DEVICE
public
mixed
EVENT_TYPE_UPDATE_TOTP_DEVICE
= 'UPDATE_TOTP_DEVICE'
STATUS_FAILURE
public
mixed
STATUS_FAILURE
= 'FAILURE'
STATUS_SUCCESS
public
mixed
STATUS_SUCCESS
= 'SUCCESS'
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
= ['id' => 'id', 'user_id' => 'userId', 'api_key_entity_id' => 'apiKeyEntityId', 'agent_name' => 'agentName', 'agent_role' => 'agentRole', 'event_type' => 'eventType', 'status' => 'status', 'tool_name' => 'toolName', 'inbox_id' => 'inboxId', 'email_id' => 'emailId', 'draft_id' => 'draftId', 'error_message' => 'errorMessage', 'created_at' => 'createdAt', 'conversation_id' => 'conversationId', 'thread_id' => 'threadId', 'action_name' => 'actionName', 'action_request_id' => 'actionRequestId', 'error_code' => 'errorCode', 'phone_number_id' => 'phoneNumberId', 'sms_id' => 'smsId', 'sent_sms_id' => 'sentSmsId', 'sms_participant' => 'smsParticipant']
$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', 'api_key_entity_id' => 'getApiKeyEntityId', 'agent_name' => 'getAgentName', 'agent_role' => 'getAgentRole', 'event_type' => 'getEventType', 'status' => 'getStatus', 'tool_name' => 'getToolName', 'inbox_id' => 'getInboxId', 'email_id' => 'getEmailId', 'draft_id' => 'getDraftId', 'error_message' => 'getErrorMessage', 'created_at' => 'getCreatedAt', 'conversation_id' => 'getConversationId', 'thread_id' => 'getThreadId', 'action_name' => 'getActionName', 'action_request_id' => 'getActionRequestId', 'error_code' => 'getErrorCode', 'phone_number_id' => 'getPhoneNumberId', 'sms_id' => 'getSmsId', 'sent_sms_id' => 'getSentSmsId', 'sms_participant' => 'getSmsParticipant']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'user_id' => 'uuid', 'api_key_entity_id' => 'uuid', 'agent_name' => null, 'agent_role' => null, 'event_type' => null, 'status' => null, 'tool_name' => null, 'inbox_id' => 'uuid', 'email_id' => 'uuid', 'draft_id' => 'uuid', 'error_message' => null, 'created_at' => 'date-time', 'conversation_id' => 'uuid', 'thread_id' => 'uuid', 'action_name' => null, 'action_request_id' => 'uuid', 'error_code' => null, 'phone_number_id' => 'uuid', 'sms_id' => 'uuid', 'sent_sms_id' => 'uuid', 'sms_participant' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AgentActivityDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'api_key_entity_id' => true, 'agent_name' => true, 'agent_role' => true, 'event_type' => false, 'status' => false, 'tool_name' => true, 'inbox_id' => true, 'email_id' => true, 'draft_id' => true, 'error_message' => true, 'created_at' => false, 'conversation_id' => true, 'thread_id' => true, 'action_name' => true, 'action_request_id' => true, 'error_code' => true, 'phone_number_id' => true, 'sms_id' => true, 'sent_sms_id' => true, 'sms_participant' => 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', 'api_key_entity_id' => 'string', 'agent_name' => 'string', 'agent_role' => 'string', 'event_type' => 'string', 'status' => 'string', 'tool_name' => 'string', 'inbox_id' => 'string', 'email_id' => 'string', 'draft_id' => 'string', 'error_message' => 'string', 'created_at' => '\\DateTime', 'conversation_id' => 'string', 'thread_id' => 'string', 'action_name' => 'string', 'action_request_id' => 'string', 'error_code' => 'string', 'phone_number_id' => 'string', 'sms_id' => 'string', 'sent_sms_id' => 'string', 'sms_participant' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'user_id' => 'setUserId', 'api_key_entity_id' => 'setApiKeyEntityId', 'agent_name' => 'setAgentName', 'agent_role' => 'setAgentRole', 'event_type' => 'setEventType', 'status' => 'setStatus', 'tool_name' => 'setToolName', 'inbox_id' => 'setInboxId', 'email_id' => 'setEmailId', 'draft_id' => 'setDraftId', 'error_message' => 'setErrorMessage', 'created_at' => 'setCreatedAt', 'conversation_id' => 'setConversationId', 'thread_id' => 'setThreadId', 'action_name' => 'setActionName', 'action_request_id' => 'setActionRequestId', 'error_code' => 'setErrorCode', 'phone_number_id' => 'setPhoneNumberId', 'sms_id' => 'setSmsId', 'sent_sms_id' => 'setSentSmsId', 'sms_participant' => 'setSmsParticipant']
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> —getActionName()
Gets action_name
public
getActionName() : string|null
Return values
string|null —getActionRequestId()
Gets action_request_id
public
getActionRequestId() : string|null
Return values
string|null —getAgentName()
Gets agent_name
public
getAgentName() : string|null
Return values
string|null —getAgentRole()
Gets agent_role
public
getAgentRole() : string|null
Return values
string|null —getAgentRoleAllowableValues()
Gets allowable values of the enum
public
getAgentRoleAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getApiKeyEntityId()
Gets api_key_entity_id
public
getApiKeyEntityId() : string|null
Return values
string|null —getConversationId()
Gets conversation_id
public
getConversationId() : string|null
Return values
string|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getDraftId()
Gets draft_id
public
getDraftId() : string|null
Return values
string|null —getEmailId()
Gets email_id
public
getEmailId() : string|null
Return values
string|null —getErrorCode()
Gets error_code
public
getErrorCode() : string|null
Return values
string|null —getErrorMessage()
Gets error_message
public
getErrorMessage() : string|null
Return values
string|null —getEventType()
Gets event_type
public
getEventType() : string
Return values
string —getEventTypeAllowableValues()
Gets allowable values of the enum
public
getEventTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getId()
Gets id
public
getId() : string
Return values
string —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 —getPhoneNumberId()
Gets phone_number_id
public
getPhoneNumberId() : string|null
Return values
string|null —getSentSmsId()
Gets sent_sms_id
public
getSentSmsId() : string|null
Return values
string|null —getSmsId()
Gets sms_id
public
getSmsId() : string|null
Return values
string|null —getSmsParticipant()
Gets sms_participant
public
getSmsParticipant() : string|null
Return values
string|null —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : 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> —getThreadId()
Gets thread_id
public
getThreadId() : string|null
Return values
string|null —getToolName()
Gets tool_name
public
getToolName() : string|null
Return values
string|null —getUserId()
Gets user_id
public
getUserId() : string
Return values
string —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> —setActionName()
Sets action_name
public
setActionName(string|null $action_name) : self
Parameters
- $action_name : string|null
-
action_name
Return values
self —setActionRequestId()
Sets action_request_id
public
setActionRequestId(string|null $action_request_id) : self
Parameters
- $action_request_id : string|null
-
action_request_id
Return values
self —setAgentName()
Sets agent_name
public
setAgentName(string|null $agent_name) : self
Parameters
- $agent_name : string|null
-
agent_name
Return values
self —setAgentRole()
Sets agent_role
public
setAgentRole(string|null $agent_role) : self
Parameters
- $agent_role : string|null
-
agent_role
Return values
self —setApiKeyEntityId()
Sets api_key_entity_id
public
setApiKeyEntityId(string|null $api_key_entity_id) : self
Parameters
- $api_key_entity_id : string|null
-
api_key_entity_id
Return values
self —setConversationId()
Sets conversation_id
public
setConversationId(string|null $conversation_id) : self
Parameters
- $conversation_id : string|null
-
conversation_id
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setDraftId()
Sets draft_id
public
setDraftId(string|null $draft_id) : self
Parameters
- $draft_id : string|null
-
draft_id
Return values
self —setEmailId()
Sets email_id
public
setEmailId(string|null $email_id) : self
Parameters
- $email_id : string|null
-
email_id
Return values
self —setErrorCode()
Sets error_code
public
setErrorCode(string|null $error_code) : self
Parameters
- $error_code : string|null
-
error_code
Return values
self —setErrorMessage()
Sets error_message
public
setErrorMessage(string|null $error_message) : self
Parameters
- $error_message : string|null
-
error_message
Return values
self —setEventType()
Sets event_type
public
setEventType(string $event_type) : self
Parameters
- $event_type : string
-
event_type
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
inbox_id
Return values
self —setPhoneNumberId()
Sets phone_number_id
public
setPhoneNumberId(string|null $phone_number_id) : self
Parameters
- $phone_number_id : string|null
-
phone_number_id
Return values
self —setSentSmsId()
Sets sent_sms_id
public
setSentSmsId(string|null $sent_sms_id) : self
Parameters
- $sent_sms_id : string|null
-
sent_sms_id
Return values
self —setSmsId()
Sets sms_id
public
setSmsId(string|null $sms_id) : self
Parameters
- $sms_id : string|null
-
sms_id
Return values
self —setSmsParticipant()
Sets sms_participant
public
setSmsParticipant(string|null $sms_participant) : self
Parameters
- $sms_participant : string|null
-
sms_participant
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
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> —setThreadId()
Sets thread_id
public
setThreadId(string|null $thread_id) : self
Parameters
- $thread_id : string|null
-
thread_id
Return values
self —setToolName()
Sets tool_name
public
setToolName(string|null $tool_name) : self
Parameters
- $tool_name : string|null
-
tool_name
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
user_id
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>