Inttegro PHP SDK

Schedule extends DomainValue
in package

Application

FinalYes

A scheduled operation and its timing, creation, cancellation, and failure state.

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

$chimeIds : array<int, string>|null: Chime Ids value for this schedule.
$content : string: Content value for this schedule.
$createdAt : DateTimeImmutable: Time at which the value was created.
$customerIds : array<int, string>|null: Customer Ids value for this schedule.
$email : EmailMessage|null: Email content, safety scan result, and system-generated schema markup for email chimes.
$errors : array<int, Error>|null: Errors value for this schedule.
$executedAt : DateTimeImmutable|null: Time at which execution began.
$id : string: Unique identifier for this schedule.
$idempotencyKey : string|null: Idempotency Key value for this schedule.
$purpose : string|null: Purpose value for this schedule.
$recipients : array<int, string>: Recipients value for this schedule.
$sendAfter : DateTimeImmutable: Send After value for this schedule.
$senderId : string: Identifier of the related sender.

Methods

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

$chimeIds read-only

Chime Ids value for this schedule.


        public
            array<int, string>|null
    $chimeIds

Optional response field. PHP type: list<string>|null; wire field: chime_ids (array<string>).

$content read-only

Content value for this schedule.


        public
            string
    $content

Required response field. PHP type: string; wire field: content (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.

$customerIds read-only

Customer Ids value for this schedule.


        public
            array<int, string>|null
    $customerIds

Optional response field. PHP type: list<string>|null; wire field: customer_ids (array<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).

$errors read-only

Errors value for this schedule.


        public
            array<int, Error>|null
    $errors

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

$executedAt read-only

Time at which execution began.


        public
            DateTimeImmutable|null
    $executedAt

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

$id read-only

Unique identifier for this schedule.


        public
            string
    $id

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

$idempotencyKey read-only

Idempotency Key value for this schedule.


        public
            string|null
    $idempotencyKey

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

$purpose read-only

Purpose value for this schedule.


        public
            string|null
    $purpose

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

$recipients read-only

Recipients value for this schedule.


        public
            array<int, string>
    $recipients

Required response field. PHP type: list<string>; wire field: recipients (array<string>).

$sendAfter read-only

Send After value for this schedule.


        public
            DateTimeImmutable
    $sendAfter

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

$senderId read-only

Identifier of the related sender.


        public
            string
    $senderId

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

__construct()

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

Schedule extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$chimeIds read-only

$content read-only

$createdAt read-only

$customerIds read-only

$email read-only

$errors read-only

$executedAt read-only

$id read-only

$idempotencyKey read-only

$purpose read-only

$recipients read-only

$sendAfter read-only

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

Schedule extends DomainValue
in package

Application