Inttegro PHP SDK

Chime extends DomainValue
in package

Application

FinalYes

A notification message and its recipient, transport, content, and delivery history.

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

$createdAt : DateTimeImmutable: Time at which the value was created.
$customData : CustomData|null: Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.
$customerId : string|null: Identifier of the related customer.
$email : EmailMessage|null: Email content, safety scan result, and system-generated schema markup for email chimes.
$fullMessage : string: Rendered SMS content. Empty for email Chimes.
$id : string: Unique identifier for this chime.
$idempotencyKey : string|null: Idempotency Key value for this chime.
$purpose : string|null: Purpose value for this chime.
$recipient : Recipient: Recipient information in response.
$senderId : string: Identifier of the related sender.
$transmission : Transmission|null: Transmission value for this chime.

Methods

__construct() : mixed: Hydrates a Chime from decoded Inttegro API data.
fromArray() : static: Creates a Chime 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.

$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.

$customData read-only

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.


        public
            CustomData|null
    $customData

Optional response field. PHP type: \Inttegro\CustomData|null; wire field: custom_data (object).

$customerId read-only

Identifier of the related customer.


        public
            string|null
    $customerId

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

$email read-only

Email content, safety scan result, and system-generated schema markup for email chimes.


        public
            EmailMessage|null
    $email

Optional response field. PHP type: \Inttegro\Chime\EmailMessage|null; wire field: email (object).

$fullMessage read-only

Rendered SMS content. Empty for email Chimes.


        public
            string
    $fullMessage

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

$id read-only

Unique identifier for this chime.


        public
            string
    $id

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

$idempotencyKey read-only

Idempotency Key value for this chime.


        public
            string|null
    $idempotencyKey

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

$purpose read-only

Purpose value for this chime.


        public
            string|null
    $purpose

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

$recipient read-only

Recipient information in response.


        public
            Recipient
    $recipient

Required response field. PHP type: \Inttegro\Chime\Recipient; wire field: recipient (object).

$senderId read-only

Identifier of the related sender.


        public
            string
    $senderId

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

$transmission read-only

Transmission value for this chime.


        public
            Transmission|null
    $transmission

Optional response field. PHP type: \Inttegro\Chime\Transmission|null; wire field: transmission (object).

__construct()

Hydrates a Chime 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 Chime 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 Chime 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.

Chime extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$createdAt read-only

$customData read-only

$customerId read-only

$email read-only

$fullMessage read-only

$id read-only

$idempotencyKey read-only

$purpose read-only

$recipient read-only

$senderId read-only

$transmission 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

Chime extends DomainValue
in package

Application