Documentation

AgentAutomationEventDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

AgentAutomationEventDto 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
TYPE_AGENT_ACTION_FAILED  = 'AGENT_ACTION_FAILED'
TYPE_AGENT_DRAFT_CREATED  = 'AGENT_DRAFT_CREATED'
TYPE_AGENT_DRAFT_SENT  = 'AGENT_DRAFT_SENT'
TYPE_AGENT_REPLY_COMPLETED  = 'AGENT_REPLY_COMPLETED'
TYPE_AGENT_SMS_REPLY_COMPLETED  = 'AGENT_SMS_REPLY_COMPLETED'
TYPE_AGENT_SMS_SENT  = 'AGENT_SMS_SENT'
TYPE_CONVERSATION_CLAIM_RELEASED  = 'CONVERSATION_CLAIM_RELEASED'
TYPE_CONVERSATION_CLAIMED  = 'CONVERSATION_CLAIMED'
TYPE_CONVERSATION_NOTE_ADDED  = 'CONVERSATION_NOTE_ADDED'
TYPE_CONVERSATION_REOPENED  = 'CONVERSATION_REOPENED'
TYPE_CONVERSATION_RESOLVED  = 'CONVERSATION_RESOLVED'
TYPE_CONVERSATION_REVIEW_DECIDED  = 'CONVERSATION_REVIEW_DECIDED'
TYPE_CONVERSATION_REVIEW_REQUESTED  = 'CONVERSATION_REVIEW_REQUESTED'
TYPE_EMAIL_RECEIVED  = 'EMAIL_RECEIVED'
TYPE_EMAIL_SENT  = 'EMAIL_SENT'
TYPE_SMS_RECEIVED  = 'SMS_RECEIVED'
TYPE_SMS_SENT  = 'SMS_SENT'
$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
getConversationId()  : string|null
Gets conversation_id
getConversationVersion()  : int|null
Gets conversation_version
getEmailId()  : string|null
Gets email_id
getEventId()  : string
Gets event_id
getInboxId()  : string|null
Gets inbox_id
getModelName()  : string
The original name of the model.
getOccurredAt()  : DateTime
Gets occurred_at
getPhoneNumberId()  : string|null
Gets phone_number_id
getPublishedAt()  : DateTime
Gets published_at
getSchemaVersion()  : int
Gets schema_version
getSentSmsId()  : string|null
Gets sent_sms_id
getSmsId()  : string|null
Gets sms_id
getSourceId()  : string|null
Gets source_id
getSourceType()  : string|null
Gets source_type
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string
Gets type
getTypeAllowableValues()  : 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
setConversationId()  : self
Sets conversation_id
setConversationVersion()  : self
Sets conversation_version
setEmailId()  : self
Sets email_id
setEventId()  : self
Sets event_id
setInboxId()  : self
Sets inbox_id
setOccurredAt()  : self
Sets occurred_at
setPhoneNumberId()  : self
Sets phone_number_id
setPublishedAt()  : self
Sets published_at
setSchemaVersion()  : self
Sets schema_version
setSentSmsId()  : self
Sets sent_sms_id
setSmsId()  : self
Sets sms_id
setSourceId()  : self
Sets source_id
setSourceType()  : self
Sets source_type
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setType()  : self
Sets type
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

TYPE_AGENT_SMS_REPLY_COMPLETED

public mixed TYPE_AGENT_SMS_REPLY_COMPLETED = 'AGENT_SMS_REPLY_COMPLETED'

TYPE_CONVERSATION_CLAIM_RELEASED

public mixed TYPE_CONVERSATION_CLAIM_RELEASED = 'CONVERSATION_CLAIM_RELEASED'

TYPE_CONVERSATION_REVIEW_DECIDED

public mixed TYPE_CONVERSATION_REVIEW_DECIDED = 'CONVERSATION_REVIEW_DECIDED'

TYPE_CONVERSATION_REVIEW_REQUESTED

public mixed TYPE_CONVERSATION_REVIEW_REQUESTED = 'CONVERSATION_REVIEW_REQUESTED'

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 = ['event_id' => 'eventId', 'type' => 'type', 'schema_version' => 'schemaVersion', 'occurred_at' => 'occurredAt', 'published_at' => 'publishedAt', 'conversation_id' => 'conversationId', 'inbox_id' => 'inboxId', 'email_id' => 'emailId', 'conversation_version' => 'conversationVersion', 'phone_number_id' => 'phoneNumberId', 'sms_id' => 'smsId', 'sent_sms_id' => 'sentSmsId', 'source_type' => 'sourceType', 'source_id' => 'sourceId']

$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 = ['event_id' => 'getEventId', 'type' => 'getType', 'schema_version' => 'getSchemaVersion', 'occurred_at' => 'getOccurredAt', 'published_at' => 'getPublishedAt', 'conversation_id' => 'getConversationId', 'inbox_id' => 'getInboxId', 'email_id' => 'getEmailId', 'conversation_version' => 'getConversationVersion', 'phone_number_id' => 'getPhoneNumberId', 'sms_id' => 'getSmsId', 'sent_sms_id' => 'getSentSmsId', 'source_type' => 'getSourceType', 'source_id' => 'getSourceId']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['event_id' => 'uuid', 'type' => null, 'schema_version' => 'int32', 'occurred_at' => 'date-time', 'published_at' => 'date-time', 'conversation_id' => 'uuid', 'inbox_id' => 'uuid', 'email_id' => 'uuid', 'conversation_version' => 'int64', 'phone_number_id' => 'uuid', 'sms_id' => 'uuid', 'sent_sms_id' => 'uuid', 'source_type' => null, 'source_id' => 'uuid']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'AgentAutomationEventDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['event_id' => false, 'type' => false, 'schema_version' => false, 'occurred_at' => false, 'published_at' => false, 'conversation_id' => true, 'inbox_id' => true, 'email_id' => true, 'conversation_version' => true, 'phone_number_id' => true, 'sms_id' => true, 'sent_sms_id' => true, 'source_type' => true, 'source_id' => 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 = ['event_id' => 'string', 'type' => 'string', 'schema_version' => 'int', 'occurred_at' => '\\DateTime', 'published_at' => '\\DateTime', 'conversation_id' => 'string', 'inbox_id' => 'string', 'email_id' => 'string', 'conversation_version' => 'int', 'phone_number_id' => 'string', 'sms_id' => 'string', 'sent_sms_id' => 'string', 'source_type' => 'string', 'source_id' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['event_id' => 'setEventId', 'type' => 'setType', 'schema_version' => 'setSchemaVersion', 'occurred_at' => 'setOccurredAt', 'published_at' => 'setPublishedAt', 'conversation_id' => 'setConversationId', 'inbox_id' => 'setInboxId', 'email_id' => 'setEmailId', 'conversation_version' => 'setConversationVersion', 'phone_number_id' => 'setPhoneNumberId', 'sms_id' => 'setSmsId', 'sent_sms_id' => 'setSentSmsId', 'source_type' => 'setSourceType', 'source_id' => 'setSourceId']

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

getConversationId()

Gets conversation_id

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

getConversationVersion()

Gets conversation_version

public getConversationVersion() : int|null
Return values
int|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 —

getSourceType()

Gets source_type

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

getters()

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

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getTypeAllowableValues()

Gets allowable values of the enum

public getTypeAllowableValues() : 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|null $conversation_id) : self
Parameters
$conversation_id : string|null

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 —

setEmailId()

Sets email_id

public setEmailId(string|null $email_id) : self
Parameters
$email_id : string|null

email_id

Return values
self —

setEventId()

Sets event_id

public setEventId(string $event_id) : self
Parameters
$event_id : string

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

setOccurredAt()

Sets occurred_at

public setOccurredAt(DateTime $occurred_at) : self
Parameters
$occurred_at : DateTime

occurred_at

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 —

setPublishedAt()

Sets published_at

public setPublishedAt(DateTime $published_at) : self
Parameters
$published_at : DateTime

published_at

Return values
self —

setSchemaVersion()

Sets schema_version

public setSchemaVersion(int $schema_version) : self
Parameters
$schema_version : int

schema_version

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 —

setSourceId()

Sets source_id

public setSourceId(string|null $source_id) : self
Parameters
$source_id : string|null

source_id

Return values
self —

setSourceType()

Sets source_type

public setSourceType(string|null $source_type) : self
Parameters
$source_type : string|null

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

setType()

Sets type

public setType(string $type) : self
Parameters
$type : string

type

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>
Return values
void —

Search results