Inttegro PHP SDK

DocumentDelivery extends DomainValue
in package

FinalYes

Delivery result for one hosted order document link.

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.

Tags
see
DomainValue

Table of Contents

Properties

$deliveries  : array<int, DocumentDeliveryAttempt>|null
Chime messages that were accepted for delivery.
$documentKind  : string|null
Hosted document that was delivered.
$documentUrl  : string|null
Hosted invoice or receipt URL sent to the customer. Receipt URLs use the hosted receipt path, not the invoice PDF path.
$failedChannels  : array<int, string>|null
Channels that failed to send.
$failures  : array<int, DocumentDeliveryFailure>|null
Per-channel delivery failures.
$sentChannels  : array<int, string>|null
Channels accepted by Chime.

Methods

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

Properties

$deliveries read-only

Chime messages that were accepted for delivery.

public array<int, DocumentDeliveryAttempt>|null $deliveries

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

$documentKind read-only

Hosted document that was delivered.

public string|null $documentKind

Optional response field. PHP type: string|null; wire field: document_kind (string). Compare against DocumentKind cases by using their ->value strings.

$documentUrl read-only

Hosted invoice or receipt URL sent to the customer. Receipt URLs use the hosted receipt path, not the invoice PDF path.

public string|null $documentUrl

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

$failedChannels read-only

Channels that failed to send.

public array<int, string>|null $failedChannels

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

$failures read-only

Per-channel delivery failures.

public array<int, DocumentDeliveryFailure>|null $failures

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

$sentChannels read-only

Channels accepted by Chime.

public array<int, string>|null $sentChannels

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

Methods

__construct()

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

Tags
throws
LogicException

Always.

offsetUnset()

Rejects unsetting because domain values are immutable.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

Ignored field name.

Tags
throws
LogicException

Always.

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.

On this page

Search results