UploadReceipt
extends DomainValue
in package
Upload Receipt details associated with file.
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.
Tags
Table of Contents
Properties
- $contentType : string
- Content Type value for this upload receipt.
- $createdAt : DateTimeImmutable
- Time at which the value was created.
- $filename : string|null
- Filename value for this upload receipt.
- $id : string
- Unique identifier for this upload receipt.
- $name : string|null
- Human-readable name.
- $size : int
- Size value for this upload receipt.
- $status : string
- Current lifecycle state.
Methods
- __construct() : mixed
- Hydrates an UploadReceipt from decoded Inttegro API data.
- fromArray() : static
- Creates an UploadReceipt 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.
Properties
$contentType read-only
Content Type value for this upload receipt.
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.
$filename read-only
Filename value for this upload receipt.
public
string|null
$filename
Optional response field. PHP type: string|null; wire field: filename (string).
$id read-only
Unique identifier for this upload receipt.
public
string
$id
Required response field. PHP type: string; wire field: id (string).
$name read-only
Human-readable name.
public
string|null
$name
Optional response field. PHP type: string|null; wire field: name (string).
$size read-only
Size value for this upload receipt.
public
int
$size
Required response field. PHP type: int; wire field: size (integer).
$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.
Methods
__construct()
Hydrates an UploadReceipt from decoded Inttegro API data.
public
__construct(array<string, mixed> $data) : mixed
Parameters
- $data : array<string, mixed>
-
Wire object keyed by
snake_caseAPI field names.
fromArray()
Creates an UploadReceipt from its decoded API wire representation.
public
static fromArray(array<string, mixed> $data) : static
Parameters
- $data : array<string, mixed>
-
Wire object keyed by
snake_caseAPI field names.
Return values
static —A typed, immutable UploadReceipt 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
camelCaseor wiresnake_casefield name.
Return values
booloffsetGet()
Reads a typed property through PHP `ArrayAccess`.
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield 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.
Tags
offsetUnset()
Rejects unsetting because domain values are immutable.
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
-
Ignored field name.
Tags
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.