Inttegro PHP SDK

Shipment extends DomainValue
in package

FinalYes

Shipment details associated with product.

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

$delivery  : Delivery|null
Delivery fulfillment marker.
$download  : Download|null
Download fulfillment marker.
$render  : Render|null
Rendered fulfillment marker.
$service  : Service|null
Service fulfillment marker.
$stream  : Stream|null
Streaming fulfillment marker.
$type  : string
Discriminator identifying the value's API variant.

Methods

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

$delivery read-only

Delivery fulfillment marker.

public Delivery|null $delivery

Optional response field. PHP type: \Inttegro\Product\Delivery|null; wire field: delivery (object).

$download read-only

Download fulfillment marker.

public Download|null $download

Optional response field. PHP type: \Inttegro\Product\Download|null; wire field: download (object).

$render read-only

Rendered fulfillment marker.

public Render|null $render

Optional response field. PHP type: \Inttegro\Product\Render|null; wire field: render (object).

$service read-only

Service fulfillment marker.

public Service|null $service

Optional response field. PHP type: \Inttegro\Product\Service|null; wire field: service (object).

$stream read-only

Streaming fulfillment marker.

public Stream|null $stream

Optional response field. PHP type: \Inttegro\Product\Stream|null; wire field: stream (object).

$type read-only

Discriminator identifying the value's API variant.

public string $type

Required response field. PHP type: string; wire field: type (string). Compare against Type cases by using their ->value strings.

Methods

__construct()

Hydrates a Shipment 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 Shipment 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 Shipment 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