Inttegro PHP SDK

UploadRequest extends DomainValue
in package

Application

FinalYes

A public upload request, including its constraints, attempts, review state, and expiration.

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

$active : bool: Whether this value is currently active.
$attempt : Attempt|null: Attempt value for this upload request.
$attempts : Attempts: Attempts value for this upload request.
$canceledAt : DateTimeImmutable|null: Time at which the operation was canceled.
$canceledBy : Actor|null: Canceled By value for this upload request.
$constraints : Constraints: Constraints value for this upload request.
$createdAt : DateTimeImmutable: Time at which the value was created.
$customData : CustomData|null: Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.
$display : Display: Display value for this upload request.
$expiredAt : DateTimeImmutable|null: Time at which the value expired.
$expiresAt : DateTimeImmutable: Timestamp associated with expires.
$fileId : string|null: Identifier of the related file.
$fulfilledAt : DateTimeImmutable|null: Timestamp associated with fulfilled.
$id : string: Unique identifier for this upload request.
$latestError : LatestError|null: Latest Error value for this upload request.
$metadata : array<string, string>|null: System-managed string metadata attached to a file resource.
$purpose : string: Purpose value for this upload request.
$recipient : Party: Recipient value for this upload request.
$requester : Actor: Requester value for this upload request.
$resource : Resource: Resource value for this upload request.
$status : string: Current lifecycle state.
$subject : Party: Subject value for this upload request.
$updatedAt : DateTimeImmutable: Time at which the value was last updated.
$uploadingAt : DateTimeImmutable|null: Timestamp associated with uploading.
$uploadUrl : string|null: Public capability URL returned when available. Treat as bearer-secret material.

Methods

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

$active read-only

Whether this value is currently active.


        public
            bool
    $active

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

$attempt read-only

Attempt value for this upload request.


        public
            Attempt|null
    $attempt

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

$attempts read-only

Attempts value for this upload request.


        public
            Attempts
    $attempts

Required response field. PHP type: \Inttegro\UploadRequest\Attempts; wire field: attempts (object).

$canceledAt read-only

Time at which the operation was canceled.


        public
            DateTimeImmutable|null
    $canceledAt

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

$canceledBy read-only

Canceled By value for this upload request.


        public
            Actor|null
    $canceledBy

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

$constraints read-only

Constraints value for this upload request.


        public
            Constraints
    $constraints

Required response field. PHP type: \Inttegro\UploadRequest\Constraints; wire field: constraints (object).

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

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

$display read-only

Display value for this upload request.


        public
            Display
    $display

Required response field. PHP type: \Inttegro\UploadRequest\Display; wire field: display (object).

$expiredAt read-only

Time at which the value expired.


        public
            DateTimeImmutable|null
    $expiredAt

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

$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|null
    $fileId

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

$fulfilledAt read-only

Timestamp associated with fulfilled.


        public
            DateTimeImmutable|null
    $fulfilledAt

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

$id read-only

Unique identifier for this upload request.


        public
            string
    $id

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

$latestError read-only

Latest Error value for this upload request.


        public
            LatestError|null
    $latestError

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

$purpose read-only

Purpose value for this upload request.


        public
            string
    $purpose

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

$recipient read-only

Recipient value for this upload request.


        public
            Party
    $recipient

Required response field. PHP type: \Inttegro\File\Party; wire field: recipient (object).

$requester read-only

Requester value for this upload request.


        public
            Actor
    $requester

Required response field. PHP type: \Inttegro\UploadRequest\Actor; wire field: requester (object).

$resource read-only

Resource value for this upload request.


        public
            Resource
    $resource

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

$subject read-only

Subject value for this upload request.


        public
            Party
    $subject

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

$uploadingAt read-only

Timestamp associated with uploading.


        public
            DateTimeImmutable|null
    $uploadingAt

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

$uploadUrl read-only

Public capability URL returned when available. Treat as bearer-secret material.


        public
            string|null
    $uploadUrl

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

__construct()

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

UploadRequest extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$active read-only

$attempt read-only

$attempts read-only

$canceledAt read-only

$canceledBy read-only

$constraints read-only

$createdAt read-only

$customData read-only

$display read-only

$expiredAt read-only

$expiresAt read-only

$fileId read-only

$fulfilledAt read-only

$id read-only

$latestError read-only

$metadata read-only

$purpose read-only

$recipient read-only

$requester read-only

$resource read-only

$status read-only

$subject read-only

$updatedAt read-only

$uploadingAt read-only

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

UploadRequest extends DomainValue
in package

Application