Inttegro PHP SDK

Transmission extends DomainValue
in package

Application

FinalYes

Transmission details associated with chime.

This immutable value hydrates decoded API snake_case data into typed camelCase properties. Use fromArray() for wire data; toArray(), array access, and JSON serialization expose the API wire representation. Nullable properties correspond to optional API fields.

Properties

$address : string: Address value for this transmission.
$createdAt : DateTimeImmutable: Time at which the value was created.
$deliveredAt : DateTimeImmutable|null: Timestamp associated with delivered.
$emailEvents : array<int, EmailEvent>|null: Email Events value for this transmission.
$emailFailureCode : string|null: Email Failure Code value for this transmission.
$emailFailureReason : string|null: Email Failure Reason value for this transmission.
$emailStatus : string|null: Email Status value for this transmission.
$error : string|null: Error value for this transmission.
$failedAt : DateTimeImmutable|null: Time at which the operation failed.
$gateway : string: Gateway value for this transmission.
$gatewayMessageId : string|null: Identifier of the related gateway message.
$id : string: Unique identifier for this transmission.
$initializedAt : DateTimeImmutable: Timestamp associated with initialized.
$lastEmailEventAt : DateTimeImmutable|null: Timestamp associated with last email event.
$mechanism : string: Mechanism value for this transmission.
$sentAt : DateTimeImmutable|null: Timestamp associated with sent.
$sentVia : string|null: Sent Via value for this transmission.
$status : string: Current lifecycle state.
$suppressedAt : DateTimeImmutable|null: Timestamp associated with suppressed.
$suppressionReason : string|null: Suppression Reason value for this transmission.

Methods

__construct() : mixed: Hydrates a Transmission from decoded Inttegro API data.
fromArray() : static: Creates a Transmission from its decoded API wire representation.
jsonSerialize() : array<string, mixed>: Returns the same API wire object as `toArray()` for `json_encode()`.
offsetExists() : bool: Reports whether a non-null property exists for a PHP or API field name.
offsetGet() : mixed: Reads a typed property through PHP `ArrayAccess`.
offsetSet() : void: Rejects mutation because domain values are immutable.
offsetUnset() : void: Rejects unsetting because domain values are immutable.
toArray() : array<string, mixed>: Converts typed properties back to the API's wire representation.

$address read-only

Address value for this transmission.


        public
            string
    $address

Required response field. PHP type: string; wire field: address (string).

$createdAt read-only

Time at which the value was created.


        public
            DateTimeImmutable
    $createdAt

Required response field. PHP type: DateTimeImmutable; wire field: created_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$deliveredAt read-only

Timestamp associated with delivered.


        public
            DateTimeImmutable|null
    $deliveredAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: delivered_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$emailEvents read-only

Email Events value for this transmission.


        public
            array<int, EmailEvent>|null
    $emailEvents

Optional response field. PHP type: list<\Inttegro\Chime\EmailEvent>|null; wire field: email_events (array<object>). When the field is absent, the SDK exposes an empty collection.

$emailFailureCode read-only

Email Failure Code value for this transmission.


        public
            string|null
    $emailFailureCode

Optional response field. PHP type: string|null; wire field: email_failure_code (string).

$emailFailureReason read-only

Email Failure Reason value for this transmission.


        public
            string|null
    $emailFailureReason

Optional response field. PHP type: string|null; wire field: email_failure_reason (string).

$emailStatus read-only

Email Status value for this transmission.


        public
            string|null
    $emailStatus

Optional response field. PHP type: string|null; wire field: email_status (string).

$error read-only

Error value for this transmission.


        public
            string|null
    $error

Optional response field. PHP type: string|null; wire field: error (string).

$failedAt read-only

Time at which the operation failed.


        public
            DateTimeImmutable|null
    $failedAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: failed_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$gateway read-only

Gateway value for this transmission.


        public
            string
    $gateway

Required response field. PHP type: string; wire field: gateway (string).

$gatewayMessageId read-only

Identifier of the related gateway message.


        public
            string|null
    $gatewayMessageId

Optional response field. PHP type: string|null; wire field: gateway_message_id (string).

$id read-only

Unique identifier for this transmission.


        public
            string
    $id

Required response field. PHP type: string; wire field: id (string).

$initializedAt read-only

Timestamp associated with initialized.


        public
            DateTimeImmutable
    $initializedAt

Required response field. PHP type: DateTimeImmutable; wire field: initialized_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$lastEmailEventAt read-only

Timestamp associated with last email event.


        public
            DateTimeImmutable|null
    $lastEmailEventAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: last_email_event_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$mechanism read-only

Mechanism value for this transmission.


        public
            string
    $mechanism

Required response field. PHP type: string; wire field: mechanism (string).

$sentAt read-only

Timestamp associated with sent.


        public
            DateTimeImmutable|null
    $sentAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: sent_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$sentVia read-only

Sent Via value for this transmission.


        public
            string|null
    $sentVia

Optional response field. PHP type: string|null; wire field: sent_via (string).

$status read-only

Current lifecycle state.


        public
            string
    $status

Required response field. PHP type: string; wire field: status (string).

$suppressedAt read-only

Timestamp associated with suppressed.


        public
            DateTimeImmutable|null
    $suppressedAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: suppressed_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$suppressionReason read-only

Suppression Reason value for this transmission.


        public
            string|null
    $suppressionReason

Optional response field. PHP type: string|null; wire field: suppression_reason (string).

__construct()

Hydrates a Transmission from decoded Inttegro API data.


    public
                    __construct(array<string, mixed> $data) : mixed

Parameters

$data : array<string, mixed>: Wire object keyed by snake_case API field names.

fromArray()

Creates a Transmission from its decoded API wire representation.


    public
            static        fromArray(array<string, mixed> $data) : static

Parameters

$data : array<string, mixed>: Wire object keyed by snake_case API field names.

Return values

static —

A typed, immutable Transmission value.

jsonSerialize()

Returns the same API wire object as `toArray()` for `json_encode()`.


    public
                    jsonSerialize() : array<string, mixed>

Return values

array<string, mixed>

offsetExists()

Reports whether a non-null property exists for a PHP or API field name.


    public
                    offsetExists(mixed $offset) : bool

Both paymentId and payment_id address the same typed property.

Parameters

$offset : mixed: PHP camelCase or wire snake_case field name.

Return values

bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed: PHP camelCase or wire snake_case field name.

Return values

mixed —

The PHP-native property value.

offsetSet()

Rejects mutation because domain values are immutable.


    public
                    offsetSet(mixed $offset, mixed $value) : void

Parameters

$offset : mixed: Ignored field name.
$value : mixed: Ignored replacement value.

offsetUnset()

Rejects unsetting because domain values are immutable.


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed: Ignored field name.

toArray()

Converts typed properties back to the API's wire representation.


    public
                    toArray() : array<string, mixed>

Property names become snake_case. Nested values, arrays, backed enums, and timestamps are normalized recursively so the result is safe to pass to json_encode().

Return values

array<string, mixed> —

The recursively normalized API object.

Transmission extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$address read-only

$createdAt read-only

$deliveredAt read-only

$emailEvents read-only

$emailFailureCode read-only

$emailFailureReason read-only

$emailStatus read-only

$error read-only

$failedAt read-only

$gateway read-only

$gatewayMessageId read-only

$id read-only

$initializedAt read-only

$lastEmailEventAt read-only

$mechanism read-only

$sentAt read-only

$sentVia read-only

$status read-only

$suppressedAt read-only

$suppressionReason read-only

Methods

__construct()

Parameters

fromArray()

Parameters

Return values

jsonSerialize()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Return values

offsetSet()

Parameters

Tags

offsetUnset()

Parameters

Tags

toArray()

Return values

Transmission extends DomainValue
in package

Application