Documentation

AITransformResultDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

AITransformResultDto 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
ENTITY_TYPE_INBOX  = 'INBOX'
ENTITY_TYPE_PHONE  = 'PHONE'
$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
getAiTransformId()  : string
Gets ai_transform_id
getAiTransformMappingId()  : string
Gets ai_transform_mapping_id
getCreatedAt()  : DateTime
Gets created_at
getEntityId()  : string
Gets entity_id
getEntityType()  : string
Gets entity_type
getEntityTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUpdatedAt()  : DateTime
Gets updated_at
getUserId()  : string
Gets user_id
getValue()  : object
Gets value
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
setAiTransformId()  : self
Sets ai_transform_id
setAiTransformMappingId()  : self
Sets ai_transform_mapping_id
setCreatedAt()  : self
Sets created_at
setEntityId()  : self
Sets entity_id
setEntityType()  : self
Sets entity_type
setId()  : self
Sets id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUpdatedAt()  : self
Sets updated_at
setUserId()  : self
Sets user_id
setValue()  : self
Sets value
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 = ['id' => 'id', 'user_id' => 'userId', 'ai_transform_id' => 'aiTransformId', 'ai_transform_mapping_id' => 'aiTransformMappingId', 'value' => 'value', 'entity_id' => 'entityId', 'entity_type' => 'entityType', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$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', 'ai_transform_id' => 'getAiTransformId', 'ai_transform_mapping_id' => 'getAiTransformMappingId', 'value' => 'getValue', 'entity_id' => 'getEntityId', 'entity_type' => 'getEntityType', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'user_id' => 'uuid', 'ai_transform_id' => 'uuid', 'ai_transform_mapping_id' => 'uuid', 'value' => null, 'entity_id' => 'uuid', 'entity_type' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'AITransformResultDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'user_id' => false, 'ai_transform_id' => false, 'ai_transform_mapping_id' => false, 'value' => true, 'entity_id' => false, 'entity_type' => false, 'created_at' => false, 'updated_at' => 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 = ['id' => 'string', 'user_id' => 'string', 'ai_transform_id' => 'string', 'ai_transform_mapping_id' => 'string', 'value' => 'object', 'entity_id' => 'string', 'entity_type' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'user_id' => 'setUserId', 'ai_transform_id' => 'setAiTransformId', 'ai_transform_mapping_id' => 'setAiTransformMappingId', 'value' => 'setValue', 'entity_id' => 'setEntityId', 'entity_type' => 'setEntityType', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']

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>

getAiTransformId()

Gets ai_transform_id

public getAiTransformId() : string
Return values
string

getAiTransformMappingId()

Gets ai_transform_mapping_id

public getAiTransformMappingId() : string
Return values
string

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime

getEntityType()

Gets entity_type

public getEntityType() : string
Return values
string

getEntityTypeAllowableValues()

Gets allowable values of the enum

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
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

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>

setAiTransformId()

Sets ai_transform_id

public setAiTransformId(string $ai_transform_id) : self
Parameters
$ai_transform_id : string

ai_transform_id

Return values
self

setAiTransformMappingId()

Sets ai_transform_mapping_id

public setAiTransformMappingId(string $ai_transform_mapping_id) : self
Parameters
$ai_transform_mapping_id : string

ai_transform_mapping_id

Return values
self

setCreatedAt()

Sets created_at

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

created_at

Return values
self

setEntityId()

Sets entity_id

public setEntityId(string $entity_id) : self
Parameters
$entity_id : string

entity_id

Return values
self

setEntityType()

Sets entity_type

public setEntityType(string $entity_type) : self
Parameters
$entity_type : string

entity_type

Return values
self

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

id

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

setUserId()

Sets user_id

public setUserId(string $user_id) : self
Parameters
$user_id : string

user_id

Return values
self

setValue()

Sets value

public setValue(object $value) : self
Parameters
$value : object

value

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