AgentConversationDetailV2DtoActiveHandoff
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AgentConversationDetailV2DtoActiveHandoff Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- PRIORITY_HIGH = 'HIGH'
- PRIORITY_LOW = 'LOW'
- PRIORITY_NORMAL = 'NORMAL'
- PRIORITY_URGENT = 'URGENT'
- STATUS_APPROVED = 'APPROVED'
- STATUS_ASSIGNED = 'ASSIGNED'
- STATUS_REJECTED = 'REJECTED'
- STATUS_REQUESTED = 'REQUESTED'
- STATUS_RESOLVED = 'RESOLVED'
- $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
- getAssignedUserId() : string|null
- Gets assigned_user_id
- getCompletedAt() : DateTime|null
- Gets completed_at
- getConversationId() : string
- Gets conversation_id
- getConversationVersion() : int|null
- Gets conversation_version
- getCreatedAt() : DateTime
- Gets created_at
- getDraftId() : string|null
- Gets draft_id
- getId() : string
- Gets id
- getModelName() : string
- The original name of the model.
- getPriority() : string
- Gets priority
- getPriorityAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getReason() : string|null
- Gets reason
- getReasonCode() : string
- Gets reason_code
- getRequestedByApiKeyEntityId() : string|null
- Gets requested_by_api_key_entity_id
- getRequestedByUserId() : string|null
- Gets requested_by_user_id
- getSourceEmailId() : string|null
- Gets source_email_id
- getSourceSmsId() : string|null
- Gets source_sms_id
- 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)
- getUpdatedAt() : DateTime
- Gets updated_at
- getVersion() : int
- Gets version
- 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
- setAssignedUserId() : self
- Sets assigned_user_id
- setCompletedAt() : self
- Sets completed_at
- setConversationId() : self
- Sets conversation_id
- setConversationVersion() : self
- Sets conversation_version
- setCreatedAt() : self
- Sets created_at
- setDraftId() : self
- Sets draft_id
- setId() : self
- Sets id
- setPriority() : self
- Sets priority
- setReason() : self
- Sets reason
- setReasonCode() : self
- Sets reason_code
- setRequestedByApiKeyEntityId() : self
- Sets requested_by_api_key_entity_id
- setRequestedByUserId() : self
- Sets requested_by_user_id
- setSourceEmailId() : self
- Sets source_email_id
- setSourceSmsId() : self
- Sets source_sms_id
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUpdatedAt() : self
- Sets updated_at
- setVersion() : self
- Sets version
- 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
PRIORITY_HIGH
public
mixed
PRIORITY_HIGH
= 'HIGH'
PRIORITY_LOW
public
mixed
PRIORITY_LOW
= 'LOW'
PRIORITY_NORMAL
public
mixed
PRIORITY_NORMAL
= 'NORMAL'
PRIORITY_URGENT
public
mixed
PRIORITY_URGENT
= 'URGENT'
STATUS_APPROVED
public
mixed
STATUS_APPROVED
= 'APPROVED'
STATUS_ASSIGNED
public
mixed
STATUS_ASSIGNED
= 'ASSIGNED'
STATUS_REJECTED
public
mixed
STATUS_REJECTED
= 'REJECTED'
STATUS_REQUESTED
public
mixed
STATUS_REQUESTED
= 'REQUESTED'
STATUS_RESOLVED
public
mixed
STATUS_RESOLVED
= 'RESOLVED'
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', 'conversation_id' => 'conversationId', 'requested_by_api_key_entity_id' => 'requestedByApiKeyEntityId', 'requested_by_user_id' => 'requestedByUserId', 'reason_code' => 'reasonCode', 'reason' => 'reason', 'priority' => 'priority', 'status' => 'status', 'assigned_user_id' => 'assignedUserId', 'source_email_id' => 'sourceEmailId', 'draft_id' => 'draftId', 'version' => 'version', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'completed_at' => 'completedAt', 'source_sms_id' => 'sourceSmsId', 'conversation_version' => 'conversationVersion']
$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', 'conversation_id' => 'getConversationId', 'requested_by_api_key_entity_id' => 'getRequestedByApiKeyEntityId', 'requested_by_user_id' => 'getRequestedByUserId', 'reason_code' => 'getReasonCode', 'reason' => 'getReason', 'priority' => 'getPriority', 'status' => 'getStatus', 'assigned_user_id' => 'getAssignedUserId', 'source_email_id' => 'getSourceEmailId', 'draft_id' => 'getDraftId', 'version' => 'getVersion', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'completed_at' => 'getCompletedAt', 'source_sms_id' => 'getSourceSmsId', 'conversation_version' => 'getConversationVersion']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'conversation_id' => 'uuid', 'requested_by_api_key_entity_id' => 'uuid', 'requested_by_user_id' => 'uuid', 'reason_code' => null, 'reason' => null, 'priority' => null, 'status' => null, 'assigned_user_id' => 'uuid', 'source_email_id' => 'uuid', 'draft_id' => 'uuid', 'version' => 'int64', 'created_at' => 'date-time', 'updated_at' => 'date-time', 'completed_at' => 'date-time', 'source_sms_id' => 'uuid', 'conversation_version' => 'int64']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AgentConversationDetailV2Dto_activeHandoff'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'conversation_id' => false, 'requested_by_api_key_entity_id' => true, 'requested_by_user_id' => true, 'reason_code' => false, 'reason' => true, 'priority' => false, 'status' => false, 'assigned_user_id' => true, 'source_email_id' => true, 'draft_id' => true, 'version' => false, 'created_at' => false, 'updated_at' => false, 'completed_at' => true, 'source_sms_id' => true, 'conversation_version' => 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', 'conversation_id' => 'string', 'requested_by_api_key_entity_id' => 'string', 'requested_by_user_id' => 'string', 'reason_code' => 'string', 'reason' => 'string', 'priority' => 'string', 'status' => 'string', 'assigned_user_id' => 'string', 'source_email_id' => 'string', 'draft_id' => 'string', 'version' => 'int', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'completed_at' => '\\DateTime', 'source_sms_id' => 'string', 'conversation_version' => 'int']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'conversation_id' => 'setConversationId', 'requested_by_api_key_entity_id' => 'setRequestedByApiKeyEntityId', 'requested_by_user_id' => 'setRequestedByUserId', 'reason_code' => 'setReasonCode', 'reason' => 'setReason', 'priority' => 'setPriority', 'status' => 'setStatus', 'assigned_user_id' => 'setAssignedUserId', 'source_email_id' => 'setSourceEmailId', 'draft_id' => 'setDraftId', 'version' => 'setVersion', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'completed_at' => 'setCompletedAt', 'source_sms_id' => 'setSourceSmsId', 'conversation_version' => 'setConversationVersion']
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> —getAssignedUserId()
Gets assigned_user_id
public
getAssignedUserId() : string|null
Return values
string|null —getCompletedAt()
Gets completed_at
public
getCompletedAt() : DateTime|null
Return values
DateTime|null —getConversationId()
Gets conversation_id
public
getConversationId() : string
Return values
string —getConversationVersion()
Gets conversation_version
public
getConversationVersion() : int|null
Return values
int|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getDraftId()
Gets draft_id
public
getDraftId() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPriority()
Gets priority
public
getPriority() : string
Return values
string —getPriorityAllowableValues()
Gets allowable values of the enum
public
getPriorityAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getReason()
Gets reason
public
getReason() : string|null
Return values
string|null —getReasonCode()
Gets reason_code
public
getReasonCode() : string
Return values
string —getRequestedByApiKeyEntityId()
Gets requested_by_api_key_entity_id
public
getRequestedByApiKeyEntityId() : string|null
Return values
string|null —getRequestedByUserId()
Gets requested_by_user_id
public
getRequestedByUserId() : string|null
Return values
string|null —getSourceEmailId()
Gets source_email_id
public
getSourceEmailId() : string|null
Return values
string|null —getSourceSmsId()
Gets source_sms_id
public
getSourceSmsId() : 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> —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getVersion()
Gets version
public
getVersion() : int
Return values
int —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> —setAssignedUserId()
Sets assigned_user_id
public
setAssignedUserId(string|null $assigned_user_id) : self
Parameters
- $assigned_user_id : string|null
-
assigned_user_id
Return values
self —setCompletedAt()
Sets completed_at
public
setCompletedAt(DateTime|null $completed_at) : self
Parameters
- $completed_at : DateTime|null
-
completed_at
Return values
self —setConversationId()
Sets conversation_id
public
setConversationId(string $conversation_id) : self
Parameters
- $conversation_id : string
-
conversation_id
Return values
self —setConversationVersion()
Sets conversation_version
public
setConversationVersion(int|null $conversation_version) : self
Parameters
- $conversation_version : int|null
-
conversation_version
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 —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setPriority()
Sets priority
public
setPriority(string $priority) : self
Parameters
- $priority : string
-
priority
Return values
self —setReason()
Sets reason
public
setReason(string|null $reason) : self
Parameters
- $reason : string|null
-
reason
Return values
self —setReasonCode()
Sets reason_code
public
setReasonCode(string $reason_code) : self
Parameters
- $reason_code : string
-
reason_code
Return values
self —setRequestedByApiKeyEntityId()
Sets requested_by_api_key_entity_id
public
setRequestedByApiKeyEntityId(string|null $requested_by_api_key_entity_id) : self
Parameters
- $requested_by_api_key_entity_id : string|null
-
requested_by_api_key_entity_id
Return values
self —setRequestedByUserId()
Sets requested_by_user_id
public
setRequestedByUserId(string|null $requested_by_user_id) : self
Parameters
- $requested_by_user_id : string|null
-
requested_by_user_id
Return values
self —setSourceEmailId()
Sets source_email_id
public
setSourceEmailId(string|null $source_email_id) : self
Parameters
- $source_email_id : string|null
-
source_email_id
Return values
self —setSourceSmsId()
Sets source_sms_id
public
setSourceSmsId(string|null $source_sms_id) : self
Parameters
- $source_sms_id : string|null
-
source_sms_id
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> —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —setVersion()
Sets version
public
setVersion(int $version) : self
Parameters
- $version : int
-
version
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>