Documentation

AgentConversationQueueItemDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

AgentConversationQueueItemDto 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

DISCRIMINATOR  = null
LATEST_MESSAGE_DIRECTION_INBOUND  = 'INBOUND'
LATEST_MESSAGE_DIRECTION_OUTBOUND  = 'OUTBOUND'
OUTCOME_DRAFTED  = 'DRAFTED'
OUTCOME_FAILED  = 'FAILED'
OUTCOME_READ  = 'READ'
OUTCOME_REPLIED  = 'REPLIED'
OUTCOME_RESOLVED  = 'RESOLVED'
OUTCOME_REVIEW_REQUESTED  = 'REVIEW_REQUESTED'
REVIEW_STATUS_APPROVED  = 'APPROVED'
REVIEW_STATUS_ASSIGNED  = 'ASSIGNED'
REVIEW_STATUS_NONE  = 'NONE'
REVIEW_STATUS_REJECTED  = 'REJECTED'
REVIEW_STATUS_REQUESTED  = 'REQUESTED'
REVIEW_STATUS_RESOLVED  = 'RESOLVED'
WORKFLOW_STATE_AVAILABLE  = 'AVAILABLE'
WORKFLOW_STATE_CLAIMED  = 'CLAIMED'
WORKFLOW_STATE_RESOLVED  = 'RESOLVED'
WORKFLOW_STATE_REVIEW  = 'REVIEW'
WORKFLOW_STATE_WAITING_ON_AGENT  = 'WAITING_ON_AGENT'
WORKFLOW_STATE_WAITING_ON_CUSTOMER  = 'WAITING_ON_CUSTOMER'
$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
getClaim()  : AgentConversationQueueItemDtoClaim|null
Gets claim
getConversationId()  : string
Gets conversation_id
getCreatedAt()  : DateTime
Gets created_at
getCustomer()  : string|null
Gets customer
getHasAttachments()  : bool
Gets has_attachments
getInboxId()  : string
Gets inbox_id
getLastExcerpt()  : string|null
Gets last_excerpt
getLastMessageAt()  : DateTime
Gets last_message_at
getLastSender()  : string|null
Gets last_sender
getLatestEmailId()  : string|null
Gets latest_email_id
getLatestMessageDirection()  : string
Gets latest_message_direction
getLatestMessageDirectionAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getLatestReceivedEmailId()  : string|null
Gets latest_received_email_id
getLatestSentEmailId()  : string|null
Gets latest_sent_email_id
getMessageCount()  : int
Gets message_count
getModelName()  : string
The original name of the model.
getNeedsOperationalAttention()  : bool
Gets needs_operational_attention
getOutcome()  : string|null
Gets outcome
getOutcomeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getProjectedAt()  : DateTime
Gets projected_at
getRequiresHumanReview()  : bool
Gets requires_human_review
getReviewStatus()  : string
Gets review_status
getReviewStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSubject()  : string|null
Gets subject
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getThreadId()  : string
Gets thread_id
getUnreadCount()  : int
Gets unread_count
getVersion()  : int
Gets version
getWorkflowState()  : string
Gets workflow_state
getWorkflowStateAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
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
setClaim()  : self
Sets claim
setConversationId()  : self
Sets conversation_id
setCreatedAt()  : self
Sets created_at
setCustomer()  : self
Sets customer
setHasAttachments()  : self
Sets has_attachments
setInboxId()  : self
Sets inbox_id
setLastExcerpt()  : self
Sets last_excerpt
setLastMessageAt()  : self
Sets last_message_at
setLastSender()  : self
Sets last_sender
setLatestEmailId()  : self
Sets latest_email_id
setLatestMessageDirection()  : self
Sets latest_message_direction
setLatestReceivedEmailId()  : self
Sets latest_received_email_id
setLatestSentEmailId()  : self
Sets latest_sent_email_id
setMessageCount()  : self
Sets message_count
setNeedsOperationalAttention()  : self
Sets needs_operational_attention
setOutcome()  : self
Sets outcome
setProjectedAt()  : self
Sets projected_at
setRequiresHumanReview()  : self
Sets requires_human_review
setReviewStatus()  : self
Sets review_status
setSubject()  : self
Sets subject
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setThreadId()  : self
Sets thread_id
setUnreadCount()  : self
Sets unread_count
setVersion()  : self
Sets version
setWorkflowState()  : self
Sets workflow_state
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 = ['conversation_id' => 'conversationId', 'thread_id' => 'threadId', 'inbox_id' => 'inboxId', 'subject' => 'subject', 'customer' => 'customer', 'last_sender' => 'lastSender', 'last_excerpt' => 'lastExcerpt', 'latest_message_direction' => 'latestMessageDirection', 'latest_email_id' => 'latestEmailId', 'latest_received_email_id' => 'latestReceivedEmailId', 'latest_sent_email_id' => 'latestSentEmailId', 'message_count' => 'messageCount', 'unread_count' => 'unreadCount', 'has_attachments' => 'hasAttachments', 'created_at' => 'createdAt', 'last_message_at' => 'lastMessageAt', 'projected_at' => 'projectedAt', 'version' => 'version', 'workflow_state' => 'workflowState', 'outcome' => 'outcome', 'review_status' => 'reviewStatus', 'requires_human_review' => 'requiresHumanReview', 'needs_operational_attention' => 'needsOperationalAttention', 'claim' => 'claim']

$getters

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

protected static array<string|int, string> $getters = ['conversation_id' => 'getConversationId', 'thread_id' => 'getThreadId', 'inbox_id' => 'getInboxId', 'subject' => 'getSubject', 'customer' => 'getCustomer', 'last_sender' => 'getLastSender', 'last_excerpt' => 'getLastExcerpt', 'latest_message_direction' => 'getLatestMessageDirection', 'latest_email_id' => 'getLatestEmailId', 'latest_received_email_id' => 'getLatestReceivedEmailId', 'latest_sent_email_id' => 'getLatestSentEmailId', 'message_count' => 'getMessageCount', 'unread_count' => 'getUnreadCount', 'has_attachments' => 'getHasAttachments', 'created_at' => 'getCreatedAt', 'last_message_at' => 'getLastMessageAt', 'projected_at' => 'getProjectedAt', 'version' => 'getVersion', 'workflow_state' => 'getWorkflowState', 'outcome' => 'getOutcome', 'review_status' => 'getReviewStatus', 'requires_human_review' => 'getRequiresHumanReview', 'needs_operational_attention' => 'getNeedsOperationalAttention', 'claim' => 'getClaim']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['conversation_id' => 'uuid', 'thread_id' => 'uuid', 'inbox_id' => 'uuid', 'subject' => null, 'customer' => null, 'last_sender' => null, 'last_excerpt' => null, 'latest_message_direction' => null, 'latest_email_id' => 'uuid', 'latest_received_email_id' => 'uuid', 'latest_sent_email_id' => 'uuid', 'message_count' => 'int32', 'unread_count' => 'int32', 'has_attachments' => null, 'created_at' => 'date-time', 'last_message_at' => 'date-time', 'projected_at' => 'date-time', 'version' => 'int64', 'workflow_state' => null, 'outcome' => null, 'review_status' => null, 'requires_human_review' => null, 'needs_operational_attention' => null, 'claim' => 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 = 'AgentConversationQueueItemDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['conversation_id' => false, 'thread_id' => false, 'inbox_id' => false, 'subject' => true, 'customer' => true, 'last_sender' => true, 'last_excerpt' => true, 'latest_message_direction' => false, 'latest_email_id' => true, 'latest_received_email_id' => true, 'latest_sent_email_id' => true, 'message_count' => false, 'unread_count' => false, 'has_attachments' => false, 'created_at' => false, 'last_message_at' => false, 'projected_at' => false, 'version' => false, 'workflow_state' => false, 'outcome' => true, 'review_status' => false, 'requires_human_review' => false, 'needs_operational_attention' => false, 'claim' => 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 = ['conversation_id' => 'string', 'thread_id' => 'string', 'inbox_id' => 'string', 'subject' => 'string', 'customer' => 'string', 'last_sender' => 'string', 'last_excerpt' => 'string', 'latest_message_direction' => 'string', 'latest_email_id' => 'string', 'latest_received_email_id' => 'string', 'latest_sent_email_id' => 'string', 'message_count' => 'int', 'unread_count' => 'int', 'has_attachments' => 'bool', 'created_at' => '\\DateTime', 'last_message_at' => '\\DateTime', 'projected_at' => '\\DateTime', 'version' => 'int', 'workflow_state' => 'string', 'outcome' => 'string', 'review_status' => 'string', 'requires_human_review' => 'bool', 'needs_operational_attention' => 'bool', 'claim' => '\\MailSlurp\\Models\\AgentConversationQueueItemDtoClaim']

$setters

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

protected static array<string|int, string> $setters = ['conversation_id' => 'setConversationId', 'thread_id' => 'setThreadId', 'inbox_id' => 'setInboxId', 'subject' => 'setSubject', 'customer' => 'setCustomer', 'last_sender' => 'setLastSender', 'last_excerpt' => 'setLastExcerpt', 'latest_message_direction' => 'setLatestMessageDirection', 'latest_email_id' => 'setLatestEmailId', 'latest_received_email_id' => 'setLatestReceivedEmailId', 'latest_sent_email_id' => 'setLatestSentEmailId', 'message_count' => 'setMessageCount', 'unread_count' => 'setUnreadCount', 'has_attachments' => 'setHasAttachments', 'created_at' => 'setCreatedAt', 'last_message_at' => 'setLastMessageAt', 'projected_at' => 'setProjectedAt', 'version' => 'setVersion', 'workflow_state' => 'setWorkflowState', 'outcome' => 'setOutcome', 'review_status' => 'setReviewStatus', 'requires_human_review' => 'setRequiresHumanReview', 'needs_operational_attention' => 'setNeedsOperationalAttention', 'claim' => 'setClaim']

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

getLatestMessageDirection()

Gets latest_message_direction

public getLatestMessageDirection() : string
Return values
string —

getLatestMessageDirectionAllowableValues()

Gets allowable values of the enum

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

getLatestReceivedEmailId()

Gets latest_received_email_id

public getLatestReceivedEmailId() : string|null
Return values
string|null —

getNeedsOperationalAttention()

Gets needs_operational_attention

public getNeedsOperationalAttention() : bool
Return values
bool —

getOutcomeAllowableValues()

Gets allowable values of the enum

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

getReviewStatusAllowableValues()

Gets allowable values of the enum

public getReviewStatusAllowableValues() : 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> —

getWorkflowStateAllowableValues()

Gets allowable values of the enum

public getWorkflowStateAllowableValues() : array<string|int, string>
Return values
array<string|int, 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 —

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

setConversationId()

Sets conversation_id

public setConversationId(string $conversation_id) : self
Parameters
$conversation_id : string

conversation_id

Return values
self —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

setCustomer()

Sets customer

public setCustomer(string|null $customer) : self
Parameters
$customer : string|null

customer

Return values
self —

setHasAttachments()

Sets has_attachments

public setHasAttachments(bool $has_attachments) : self
Parameters
$has_attachments : bool

has_attachments

Return values
self —

setInboxId()

Sets inbox_id

public setInboxId(string $inbox_id) : self
Parameters
$inbox_id : string

inbox_id

Return values
self —

setLastExcerpt()

Sets last_excerpt

public setLastExcerpt(string|null $last_excerpt) : self
Parameters
$last_excerpt : string|null

last_excerpt

Return values
self —

setLastMessageAt()

Sets last_message_at

public setLastMessageAt(DateTime $last_message_at) : self
Parameters
$last_message_at : DateTime

last_message_at

Return values
self —

setLastSender()

Sets last_sender

public setLastSender(string|null $last_sender) : self
Parameters
$last_sender : string|null

last_sender

Return values
self —

setLatestEmailId()

Sets latest_email_id

public setLatestEmailId(string|null $latest_email_id) : self
Parameters
$latest_email_id : string|null

latest_email_id

Return values
self —

setLatestMessageDirection()

Sets latest_message_direction

public setLatestMessageDirection(string $latest_message_direction) : self
Parameters
$latest_message_direction : string

latest_message_direction

Return values
self —

setLatestReceivedEmailId()

Sets latest_received_email_id

public setLatestReceivedEmailId(string|null $latest_received_email_id) : self
Parameters
$latest_received_email_id : string|null

latest_received_email_id

Return values
self —

setLatestSentEmailId()

Sets latest_sent_email_id

public setLatestSentEmailId(string|null $latest_sent_email_id) : self
Parameters
$latest_sent_email_id : string|null

latest_sent_email_id

Return values
self —

setMessageCount()

Sets message_count

public setMessageCount(int $message_count) : self
Parameters
$message_count : int

message_count

Return values
self —

setNeedsOperationalAttention()

Sets needs_operational_attention

public setNeedsOperationalAttention(bool $needs_operational_attention) : self
Parameters
$needs_operational_attention : bool

needs_operational_attention

Return values
self —

setOutcome()

Sets outcome

public setOutcome(string|null $outcome) : self
Parameters
$outcome : string|null

outcome

Return values
self —

setProjectedAt()

Sets projected_at

public setProjectedAt(DateTime $projected_at) : self
Parameters
$projected_at : DateTime

projected_at

Return values
self —

setRequiresHumanReview()

Sets requires_human_review

public setRequiresHumanReview(bool $requires_human_review) : self
Parameters
$requires_human_review : bool

requires_human_review

Return values
self —

setReviewStatus()

Sets review_status

public setReviewStatus(string $review_status) : self
Parameters
$review_status : string

review_status

Return values
self —

setSubject()

Sets subject

public setSubject(string|null $subject) : self
Parameters
$subject : string|null

subject

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 $thread_id) : self
Parameters
$thread_id : string

thread_id

Return values
self —

setUnreadCount()

Sets unread_count

public setUnreadCount(int $unread_count) : self
Parameters
$unread_count : int

unread_count

Return values
self —

setVersion()

Sets version

public setVersion(int $version) : self
Parameters
$version : int

version

Return values
self —

setWorkflowState()

Sets workflow_state

public setWorkflowState(string $workflow_state) : self
Parameters
$workflow_state : string

workflow_state

Return values
self —

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