CreateAITransformerMappingOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateAITransformerMappingOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- CONTENT_SELECTOR_BODY = 'BODY'
- CONTENT_SELECTOR_BODY_ATTACHMENTS = 'BODY_ATTACHMENTS'
- CONTENT_SELECTOR_RAW = 'RAW'
- DISCRIMINATOR = null
- ENTITY_TYPE_INBOX = 'INBOX'
- ENTITY_TYPE_PHONE = 'PHONE'
- TRIGGER_SELECTOR_ATTACHMENT = 'PER_ATTACHMENT'
- TRIGGER_SELECTOR_MESSAGE = 'PER_MESSAGE'
- $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
- getContentSelector() : string|null
- Gets content_selector
- getContentSelectorAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getEntityId() : string|null
- Gets entity_id
- getEntityType() : string
- Gets entity_type
- getEntityTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getSpreadRootArray() : bool|null
- Gets spread_root_array
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTriggerSelector() : string|null
- Gets trigger_selector
- getTriggerSelectorAllowableValues() : 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
- setAiTransformId() : self
- Sets ai_transform_id
- setContentSelector() : self
- Sets content_selector
- setEntityId() : self
- Sets entity_id
- setEntityType() : self
- Sets entity_type
- setName() : self
- Sets name
- setSpreadRootArray() : self
- Sets spread_root_array
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTriggerSelector() : self
- Sets trigger_selector
- 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
CONTENT_SELECTOR_BODY
public
mixed
CONTENT_SELECTOR_BODY
= 'BODY'
CONTENT_SELECTOR_BODY_ATTACHMENTS
public
mixed
CONTENT_SELECTOR_BODY_ATTACHMENTS
= 'BODY_ATTACHMENTS'
CONTENT_SELECTOR_RAW
public
mixed
CONTENT_SELECTOR_RAW
= 'RAW'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
ENTITY_TYPE_INBOX
public
mixed
ENTITY_TYPE_INBOX
= 'INBOX'
ENTITY_TYPE_PHONE
public
mixed
ENTITY_TYPE_PHONE
= 'PHONE'
TRIGGER_SELECTOR_ATTACHMENT
public
mixed
TRIGGER_SELECTOR_ATTACHMENT
= 'PER_ATTACHMENT'
TRIGGER_SELECTOR_MESSAGE
public
mixed
TRIGGER_SELECTOR_MESSAGE
= 'PER_MESSAGE'
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
= ['name' => 'name', 'ai_transform_id' => 'aiTransformId', 'entity_id' => 'entityId', 'entity_type' => 'entityType', 'content_selector' => 'contentSelector', 'trigger_selector' => 'triggerSelector', 'spread_root_array' => 'spreadRootArray']
$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
= ['name' => 'getName', 'ai_transform_id' => 'getAiTransformId', 'entity_id' => 'getEntityId', 'entity_type' => 'getEntityType', 'content_selector' => 'getContentSelector', 'trigger_selector' => 'getTriggerSelector', 'spread_root_array' => 'getSpreadRootArray']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['name' => null, 'ai_transform_id' => 'uuid', 'entity_id' => 'uuid', 'entity_type' => null, 'content_selector' => null, 'trigger_selector' => null, 'spread_root_array' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateAITransformerMappingOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['name' => true, 'ai_transform_id' => false, 'entity_id' => true, 'entity_type' => false, 'content_selector' => true, 'trigger_selector' => true, 'spread_root_array' => 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
= ['name' => 'string', 'ai_transform_id' => 'string', 'entity_id' => 'string', 'entity_type' => 'string', 'content_selector' => 'string', 'trigger_selector' => 'string', 'spread_root_array' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'ai_transform_id' => 'setAiTransformId', 'entity_id' => 'setEntityId', 'entity_type' => 'setEntityType', 'content_selector' => 'setContentSelector', 'trigger_selector' => 'setTriggerSelector', 'spread_root_array' => 'setSpreadRootArray']
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 —getContentSelector()
Gets content_selector
public
getContentSelector() : string|null
Return values
string|null —getContentSelectorAllowableValues()
Gets allowable values of the enum
public
getContentSelectorAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getEntityId()
Gets entity_id
public
getEntityId() : string|null
Return values
string|null —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 —getName()
Gets name
public
getName() : string|null
Return values
string|null —getSpreadRootArray()
Gets spread_root_array
public
getSpreadRootArray() : bool|null
Return values
bool|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> —getTriggerSelector()
Gets trigger_selector
public
getTriggerSelector() : string|null
Return values
string|null —getTriggerSelectorAllowableValues()
Gets allowable values of the enum
public
getTriggerSelectorAllowableValues() : 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 —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> —setAiTransformId()
Sets ai_transform_id
public
setAiTransformId(string $ai_transform_id) : self
Parameters
- $ai_transform_id : string
-
ai_transform_id
Return values
self —setContentSelector()
Sets content_selector
public
setContentSelector(string|null $content_selector) : self
Parameters
- $content_selector : string|null
-
content_selector
Return values
self —setEntityId()
Sets entity_id
public
setEntityId(string|null $entity_id) : self
Parameters
- $entity_id : string|null
-
entity_id
Return values
self —setEntityType()
Sets entity_type
public
setEntityType(string $entity_type) : self
Parameters
- $entity_type : string
-
entity_type
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
name
Return values
self —setSpreadRootArray()
Sets spread_root_array
public
setSpreadRootArray(bool|null $spread_root_array) : self
Parameters
- $spread_root_array : bool|null
-
spread_root_array
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> —setTriggerSelector()
Sets trigger_selector
public
setTriggerSelector(string|null $trigger_selector) : self
Parameters
- $trigger_selector : string|null
-
trigger_selector
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>