Inttegro PHP SDK

FileLink extends DomainValue
in package

Application

FinalYes

A public file-link record and its access, delivery, and revocation 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

$access : Access: Access value for this file link.
$active : bool: Whether this value is currently active.
$createdAt : DateTimeImmutable: Time at which the value was created.
$createdBy : Actor: Created By value for this file link.
$customData : CustomData|null: Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.
$delivery : Delivery: Delivery value for this file link.
$expiresAt : DateTimeImmutable: Timestamp associated with expires.
$fileId : string: Identifier of the related file.
$id : string: Unique identifier for this file link.
$kind : string: Kind value for this file link.
$metadata : array<string, string>|null: System-managed string metadata attached to a file resource.
$purpose : string: Purpose value for this file link.
$revokedAt : DateTimeImmutable|null: Timestamp associated with revoked.
$revokedBy : Actor|null: Revoked By value for this file link.
$status : string: Current lifecycle state.
$updatedAt : DateTimeImmutable: Time at which the value was last updated.

Methods

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

$access read-only

Access value for this file link.


        public
            Access
    $access

Required response field. PHP type: \Inttegro\FileLink\Access; wire field: access (object).

$active read-only

Whether this value is currently active.


        public
            bool
    $active

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

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

$createdBy read-only

Created By value for this file link.


        public
            Actor
    $createdBy

Required response field. PHP type: \Inttegro\FileLink\Actor; wire field: created_by (object).

$customData read-only

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.


        public
            CustomData|null
    $customData

Optional response field. PHP type: \Inttegro\CustomData|null; wire field: custom_data (object).

$delivery read-only

Delivery value for this file link.


        public
            Delivery
    $delivery

Required response field. PHP type: \Inttegro\FileLink\Delivery; wire field: delivery (object).

$expiresAt read-only

Timestamp associated with expires.


        public
            DateTimeImmutable
    $expiresAt

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

$fileId read-only

Identifier of the related file.


        public
            string
    $fileId

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

$id read-only

Unique identifier for this file link.


        public
            string
    $id

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

$kind read-only

Kind value for this file link.


        public
            string
    $kind

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

$metadata read-only

System-managed string metadata attached to a file resource.


        public
            array<string, string>|null
    $metadata

Optional response field. PHP type: array<string, string>|null; wire field: metadata (object).

$purpose read-only

Purpose value for this file link.


        public
            string
    $purpose

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

$revokedAt read-only

Timestamp associated with revoked.


        public
            DateTimeImmutable|null
    $revokedAt

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

$revokedBy read-only

Revoked By value for this file link.


        public
            Actor|null
    $revokedBy

Optional response field. PHP type: \Inttegro\FileLink\Actor|null; wire field: revoked_by (object).

$status read-only

Current lifecycle state.


        public
            string
    $status

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

$updatedAt read-only

Time at which the value was last updated.


        public
            DateTimeImmutable
    $updatedAt

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

__construct()

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

FileLink extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$access read-only

$active read-only

$createdAt read-only

$createdBy read-only

$customData read-only

$delivery read-only

$expiresAt read-only

$fileId read-only

$id read-only

$kind read-only

$metadata read-only

$purpose read-only

$revokedAt read-only

$revokedBy read-only

$status read-only

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

FileLink extends DomainValue
in package

Application