Inttegro PHP SDK

Relationship extends DomainValue
in package

Application

FinalYes

Relationship receipt for the created child app.

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

$actorAppId : string: Identifier of the related actor app.
$childAppId : string: Identifier of the related child app.
$childStanding : string: Child Standing value for this relationship.
$createdAt : DateTimeImmutable: Time at which the value was created.
$creatorAppId : string: Identifier of the related creator app.
$id : string: Unique identifier for this relationship.
$kind : string: Kind value for this relationship.
$placementParentAppId : string: Identifier of the related placement parent app.
$policyVersion : string: Policy Version value for this relationship.
$relationshipPolicy : RelationshipPolicy: Relationship Policy value for this relationship.
$retainedCreatorAuthorityExists : bool: Retained Creator Authority Exists value for this relationship.
$status : string: Current lifecycle state.
$subjectAppId : string: Identifier of the related subject app.

Methods

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

$actorAppId read-only

Identifier of the related actor app.


        public
            string
    $actorAppId

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

$childAppId read-only

Identifier of the related child app.


        public
            string
    $childAppId

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

$childStanding read-only

Child Standing value for this relationship.


        public
            string
    $childStanding

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

$creatorAppId read-only

Identifier of the related creator app.


        public
            string
    $creatorAppId

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

$id read-only

Unique identifier for this relationship.


        public
            string
    $id

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

$kind read-only

Kind value for this relationship.


        public
            string
    $kind

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

$placementParentAppId read-only

Identifier of the related placement parent app.


        public
            string
    $placementParentAppId

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

$policyVersion read-only

Policy Version value for this relationship.


        public
            string
    $policyVersion

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

$relationshipPolicy read-only

Relationship Policy value for this relationship.


        public
            RelationshipPolicy
    $relationshipPolicy

Required response field. PHP type: \Inttegro\App\RelationshipPolicy; wire field: relationship_policy (object).

$retainedCreatorAuthorityExists read-only

Retained Creator Authority Exists value for this relationship.


        public
            bool
    $retainedCreatorAuthorityExists

Required response field. PHP type: bool; wire field: retained_creator_authority_exists (boolean).

$status read-only

Current lifecycle state.


        public
            string
    $status

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

$subjectAppId read-only

Identifier of the related subject app.


        public
            string
    $subjectAppId

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

__construct()

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

Relationship extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$actorAppId read-only

$childAppId read-only

$childStanding read-only

$createdAt read-only

$creatorAppId read-only

$id read-only

$kind read-only

$placementParentAppId read-only

$policyVersion read-only

$relationshipPolicy read-only

$retainedCreatorAuthorityExists read-only

$status read-only

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

Relationship extends DomainValue
in package

Application