Inttegro PHP SDK

File extends DomainValue
in package

Application

FinalYes

Public metadata for a file managed by Inttegro; private storage credentials and object keys are never exposed.

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

$availableAt : DateTimeImmutable|null: Time at which the funds become available.
$checksumSha256 : string: Checksum Sha256 value for this file.
$contentType : string: Content Type value for this file.
$createdAt : DateTimeImmutable: Time at which the value was created.
$createdBy : Actor: Created By value for this file.
$customData : CustomData|null: Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.
$delivery : DeliveryDetails|null: Purpose-authorized public delivery metadata for browser-rendered assets. Callers should store file IDs as canonical references and treat these URLs as render URLs.
$expiresAt : DateTimeImmutable|null: Timestamp associated with expires.
$filename : string|null: Filename value for this file.
$id : string: Unique identifier for this file.
$latestError : LatestError|null: Latest Error value for this file.
$media : Media|null: Media value for this file.
$metadata : array<string, string>|null: System-managed string metadata attached to a file resource.
$name : string|null: Human-readable name.
$purpose : string: Purpose value for this file.
$scanStatus : string: Scan Status value for this file.
$size : int: Original byte size.
$source : Source: Source value for this file.
$status : string: Current lifecycle state.
$storage : PublicStorage: Storage value for this file.
$updatedAt : DateTimeImmutable: Time at which the value was last updated.

Methods

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

$availableAt read-only

Time at which the funds become available.


        public
            DateTimeImmutable|null
    $availableAt

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

$checksumSha256 read-only

Checksum Sha256 value for this file.


        public
            string
    $checksumSha256

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

$contentType read-only

Content Type value for this file.


        public
            string
    $contentType

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

$createdBy read-only

Created By value for this file.


        public
            Actor
    $createdBy

Required response field. PHP type: \Inttegro\File\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

Purpose-authorized public delivery metadata for browser-rendered assets. Callers should store file IDs as canonical references and treat these URLs as render URLs.


        public
            DeliveryDetails|null
    $delivery

Optional response field. PHP type: \Inttegro\File\DeliveryDetails|null; wire field: delivery (object). Compare against Delivery cases by using their ->value strings.

$expiresAt read-only

Timestamp associated with expires.


        public
            DateTimeImmutable|null
    $expiresAt

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

$filename read-only

Filename value for this file.


        public
            string|null
    $filename

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

$id read-only

Unique identifier for this file.


        public
            string
    $id

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

$latestError read-only

Latest Error value for this file.


        public
            LatestError|null
    $latestError

Optional response field. PHP type: \Inttegro\File\LatestError|null; wire field: latest_error (object).

$media read-only

Media value for this file.


        public
            Media|null
    $media

Optional response field. PHP type: \Inttegro\File\Media|null; wire field: media (object).

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

$name read-only

Human-readable name.


        public
            string|null
    $name

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

$purpose read-only

Purpose value for this file.


        public
            string
    $purpose

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

$scanStatus read-only

Scan Status value for this file.


        public
            string
    $scanStatus

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

$size read-only

Original byte size.


        public
            int
    $size

Required response field. PHP type: int; wire field: size (integer).

$source read-only

Source value for this file.


        public
            Source
    $source

Required response field. PHP type: \Inttegro\File\Source; wire field: source (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.

$storage read-only

Storage value for this file.


        public
            PublicStorage
    $storage

Required response field. PHP type: \Inttegro\File\PublicStorage; wire field: storage (object).

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

File extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$availableAt read-only

$checksumSha256 read-only

$contentType read-only

$createdAt read-only

$createdBy read-only

$customData read-only

$delivery read-only

$expiresAt read-only

$filename read-only

$id read-only

$latestError read-only

$media read-only

$metadata read-only

$name read-only

$purpose read-only

$scanStatus read-only

$size read-only

$source read-only

$status read-only

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

File extends DomainValue
in package

Application