Inttegro PHP SDK

Attempt extends DomainValue
in package

Application

FinalYes

Attempt details associated with upload request.

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

$attemptedAt : DateTimeImmutable: Timestamp associated with attempted.
$contentType : string|null: Content Type value for this attempt.
$declaredSize : int|null: Declared Size value for this attempt.
$error : LatestError|null: Error value for this attempt.
$failedAt : DateTimeImmutable|null: Time at which the operation failed.
$fileId : string|null: Identifier of the related file.
$filename : string|null: Filename value for this attempt.
$id : string: Unique identifier for this attempt.
$ordinal : int: Ordinal value for this attempt.
$review : Review|null: Review value for this attempt.
$status : string: Current lifecycle state.
$succeededAt : DateTimeImmutable|null: Timestamp associated with succeeded.
$uploadRequestId : string: Identifier of the related upload request.

Methods

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

$attemptedAt read-only

Timestamp associated with attempted.


        public
            DateTimeImmutable
    $attemptedAt

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

$contentType read-only

Content Type value for this attempt.


        public
            string|null
    $contentType

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

$declaredSize read-only

Declared Size value for this attempt.


        public
            int|null
    $declaredSize

Optional response field. PHP type: int|null; wire field: declared_size (integer).

$error read-only

Error value for this attempt.


        public
            LatestError|null
    $error

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

$failedAt read-only

Time at which the operation failed.


        public
            DateTimeImmutable|null
    $failedAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: failed_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|null
    $fileId

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

$filename read-only

Filename value for this attempt.


        public
            string|null
    $filename

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

$id read-only

Unique identifier for this attempt.


        public
            string
    $id

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

$ordinal read-only

Ordinal value for this attempt.


        public
            int
    $ordinal

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

$review read-only

Review value for this attempt.


        public
            Review|null
    $review

Optional response field. PHP type: \Inttegro\UploadRequest\Review|null; wire field: review (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.

$succeededAt read-only

Timestamp associated with succeeded.


        public
            DateTimeImmutable|null
    $succeededAt

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

$uploadRequestId read-only

Identifier of the related upload request.


        public
            string
    $uploadRequestId

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

__construct()

Hydrates an Attempt 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 an Attempt 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 Attempt 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.

Attempt extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$attemptedAt read-only

$contentType read-only

$declaredSize read-only

$error read-only

$failedAt read-only

$fileId read-only

$filename read-only

$id read-only

$ordinal read-only

$review read-only

$status read-only

$succeededAt read-only

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

Attempt extends DomainValue
in package

Application