Inttegro PHP SDK

OperatingPolicy extends DomainValue
in package

FinalYes

Latest active immutable version of a reusable operating policy.

Table of Contents

Properties

$activeVersion  : int
Active version; PHP type: `int`; wire field: `active_version` (`integer`).
$capabilities  : Capabilities
Selected capabilities; PHP type: `Capabilities`; wire field: `capabilities` (`object`).
$childrenPolicyId  : string
Governing children policy; PHP type: `string`; wire field: `children_policy_id` (`string`).
$childrenPolicyVersion  : int
Governing policy version; PHP type: `int`; wire field: `children_policy_version` (`integer`).
$createdAt  : DateTimeImmutable
Initial creation time; PHP type: `DateTimeImmutable`; wire field: `created_at` (`date-time`).
$description  : string|null
Policy description; PHP type: `string|null`; wire field: `description` (`string`).
$id  : string
Policy identifier; PHP type: `string`; wire field: `id` (`string`).
$name  : string
Policy name; PHP type: `string`; wire field: `name` (`string`).
$updatedAt  : DateTimeImmutable
Latest update time; PHP type: `DateTimeImmutable`; wire field: `updated_at` (`date-time`).
$version  : int
Returned version; PHP type: `int`; wire field: `version` (`integer`).
$versionCreatedAt  : DateTimeImmutable
Version creation time; PHP type: `DateTimeImmutable`; wire field: `version_created_at` (`date-time`).

Methods

__construct()  : mixed
fromArray()  : static
Creates a typed value from a decoded API object.
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

$activeVersion read-only

Active version; PHP type: `int`; wire field: `active_version` (`integer`).

public int $activeVersion

$capabilities read-only

Selected capabilities; PHP type: `Capabilities`; wire field: `capabilities` (`object`).

public Capabilities $capabilities

$childrenPolicyId read-only

Governing children policy; PHP type: `string`; wire field: `children_policy_id` (`string`).

public string $childrenPolicyId

$childrenPolicyVersion read-only

Governing policy version; PHP type: `int`; wire field: `children_policy_version` (`integer`).

public int $childrenPolicyVersion

$createdAt read-only

Initial creation time; PHP type: `DateTimeImmutable`; wire field: `created_at` (`date-time`).

public DateTimeImmutable $createdAt

$description read-only

Policy description; PHP type: `string|null`; wire field: `description` (`string`).

public string|null $description

$id read-only

Policy identifier; PHP type: `string`; wire field: `id` (`string`).

public string $id

$name read-only

Policy name; PHP type: `string`; wire field: `name` (`string`).

public string $name

$updatedAt read-only

Latest update time; PHP type: `DateTimeImmutable`; wire field: `updated_at` (`date-time`).

public DateTimeImmutable $updatedAt

$version read-only

Returned version; PHP type: `int`; wire field: `version` (`integer`).

public int $version

$versionCreatedAt read-only

Version creation time; PHP type: `DateTimeImmutable`; wire field: `version_created_at` (`date-time`).

public DateTimeImmutable $versionCreatedAt

Methods

__construct()

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

Wire object keyed by API field names.

fromArray()

Creates a typed value from a decoded API object.

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

Wire object keyed by API field names.

Return values
static —

A typed, immutable domain 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